Menu
▾
▴
[Plplot-cvs] SF.net SVN: plplot:[11486] trunk/bindings
|
From: <ai...@us...> - 2011-01-12 00:56:11
|
Revision: 11486
http://plplot.svn.sourceforge.net/plplot/?rev=11486&view=rev
Author: airwin
Date: 2011-01-12 00:56:04 +0000 (Wed, 12 Jan 2011)
Log Message:
-----------
Remove all docstring %feature's from plplotcapi.i. Use separate file,
swig_documentation.i (which has much more complete information derived
from api.xml) instead.
N.B. This gives excellent results on Octave, but the separate file
approach may need further tweaking to work on Python. It has been
a long time since I have looked at the Python generated help strings so
I may be doing something incorrectly, but
when I attempt to do that now using, e.g.,
pllegend.__doc__
I get no errors but also no help results.
Modified Paths:
--------------
trunk/bindings/octave/CMakeLists.txt
trunk/bindings/octave/plplot_octave.i
trunk/bindings/python/CMakeLists.txt
trunk/bindings/python/plplotcmodule.i
trunk/bindings/swig-support/plplotcapi.i
Modified: trunk/bindings/octave/CMakeLists.txt
===================================================================
--- trunk/bindings/octave/CMakeLists.txt 2011-01-12 00:22:44 UTC (rev 11485)
+++ trunk/bindings/octave/CMakeLists.txt 2011-01-12 00:56:04 UTC (rev 11486)
@@ -179,7 +179,9 @@
)
set(SWIG_MODULE_plplot_octave_EXTRA_DEPS
- ${CMAKE_SOURCE_DIR}/bindings/swig-support/plplotcapi.i)
+ ${CMAKE_SOURCE_DIR}/bindings/swig-support/swig_documentation.i
+ ${CMAKE_SOURCE_DIR}/bindings/swig-support/plplotcapi.i
+ )
# Set up swig + c wrapper.
swig_add_module(plplot_octave octave plplot_octave.i)
Modified: trunk/bindings/octave/plplot_octave.i
===================================================================
--- trunk/bindings/octave/plplot_octave.i 2011-01-12 00:22:44 UTC (rev 11485)
+++ trunk/bindings/octave/plplot_octave.i 2011-01-12 00:56:04 UTC (rev 11486)
@@ -1280,5 +1280,7 @@
// Probably never deal with this one.
%ignore plMinMax2dGrid;
+// %feature commands supporting swig-generated documentation for the bindings.
+%include swig_documentation.i
// swig-compatible common PLplot API definitions from here on.
%include plplotcapi.i
Modified: trunk/bindings/python/CMakeLists.txt
===================================================================
--- trunk/bindings/python/CMakeLists.txt 2011-01-12 00:22:44 UTC (rev 11485)
+++ trunk/bindings/python/CMakeLists.txt 2011-01-12 00:56:04 UTC (rev 11486)
@@ -71,7 +71,9 @@
set(CMAKE_SWIG_OUTDIR ${CMAKE_CURRENT_BINARY_DIR})
set(SWIG_MODULE_plplotcmodule_EXTRA_DEPS
- ${CMAKE_SOURCE_DIR}/bindings/swig-support/plplotcapi.i)
+ ${CMAKE_SOURCE_DIR}/bindings/swig-support/swig_documentation.i
+ ${CMAKE_SOURCE_DIR}/bindings/swig-support/plplotcapi.i
+ )
set_source_files_properties(plplotcmodule.i
PROPERTIES SWIG_MODULE_NAME plplotc
Modified: trunk/bindings/python/plplotcmodule.i
===================================================================
--- trunk/bindings/python/plplotcmodule.i 2011-01-12 00:22:44 UTC (rev 11485)
+++ trunk/bindings/python/plplotcmodule.i 2011-01-12 00:56:04 UTC (rev 11486)
@@ -1293,5 +1293,7 @@
%pybuffer_mutable_string(void * plotmem)
#endif
-/* swig compatible PLplot API definitions from here on. */
+/* %feature commands supporting swig-generated documentation for the bindings. *.
+%include swig_documentation.i
+/* swig-compatible PLplot API definitions from here on. */
%include plplotcapi.i
Modified: trunk/bindings/swig-support/plplotcapi.i
===================================================================
--- trunk/bindings/swig-support/plplotcapi.i 2011-01-12 00:22:44 UTC (rev 11485)
+++ trunk/bindings/swig-support/plplotcapi.i 2011-01-12 00:56:04 UTC (rev 11486)
@@ -240,8 +240,6 @@
#define SWIG_OBJECT_DATA_img OBJECT_DATA_img
#endif
-%feature( "autodoc", "1" );
-
#ifdef SWIG_PYTHON
// Non-common API that are included here because they traditionally
@@ -251,14 +249,12 @@
// Deprecated function that we no longer want to propagate to the
// python API.
-%feature( "docstring", "Plot an arrow." ) plarrows;
void
plarrows( PLFLT *Array, PLFLT *ArrayCk, PLFLT *ArrayCk, PLFLT *ArrayCk, PLINT n,
PLFLT scale, PLFLT dx, PLFLT dy );
#endif
-%feature( "docstring", "Set inferior X window." ) plsxwin;
void
plsxwin( PLINT window_id );
@@ -266,73 +262,56 @@
// Complete list of common API (has "c_" suffix version defined in plplot.h)
-%feature( "docstring", "Set the format of the contour labels." )
-pl_setcontlabelformat;
void
pl_setcontlabelformat( PLINT lexp, PLINT sigdig );
-%feature( "docstring", "Set offset and spacing of contour labels." ) pl_setcontlabelparam;
void
pl_setcontlabelparam( PLFLT offset, PLFLT size, PLFLT spacing, PLINT active );
-%feature( "docstring", "Advance to subpage \"page\", or to the next one if \"page\" = 0." ) pladv;
void
pladv( PLINT page );
-%feature( "docstring", "Plot an arc" ) plarc;
void
plarc( PLFLT x, PLFLT y, PLFLT a, PLFLT b, PLFLT angle1, PLFLT angle2,
PLBOOL fill );
-%feature( "docstring", "This functions similarly to plbox() except that the origin of the axes is placed at the user-specified point (x0, y0)." ) plaxes;
void
plaxes( PLFLT x0, PLFLT y0, const char *xopt, PLFLT xtick, PLINT nxsub,
const char *yopt, PLFLT ytick, PLINT nysub );
-%feature( "docstring", "Plot a histogram using x to store data values and y to store frequencies." ) plbin;
void
plbin( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLINT center );
-%feature( "docstring", "Calculate broken-down time from continuous time for current stream." ) plbtime;
void
plbtime( PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT, PLFLT *OUTPUT, PLFLT ctime );
-%feature( "docstring", "Start new page. Should only be used with pleop()." ) plbop;
void
plbop( void );
-%feature( "docstring", "Draw a box around the current viewport." ) plbox;
void
plbox( const char *xopt, PLFLT xtick, PLINT nxsub,
const char *yopt, PLFLT ytick, PLINT nysub );
-%feature( "docstring", "This is the 3-d analogue of plbox()." ) plbox3;
void
plbox3( const char *xopt, const char *xlabel, PLFLT xtick, PLINT nsubx,
const char *yopt, const char *ylabel, PLFLT ytick, PLINT nsuby,
const char *zopt, const char *zlabel, PLFLT ztick, PLINT nsubz );
-%feature( "docstring", "Calculate world coordinates and subpage from relative device coordinates." ) plcalc_world;
void
plcalc_world( PLFLT rx, PLFLT ry, PLFLT *OUTPUT, PLFLT *OUTPUT, PLINT *OUTPUT );
-%feature( "docstring", "Clear current subpage." ) plclear;
void
plclear( void );
-%feature( "docstring", "Set color, map 0. Argument is integer between 0 and 15." ) plcol0;
void
plcol0( PLINT icol0 );
-%feature( "docstring", "Set color, map 1. Argument is a float between 0. and 1." ) plcol1;
void
plcol1( PLFLT col1 );
-%feature( "docstring", "Configure transformation between continuous and broken-down time (and vice versa) for current stream." ) plconfigtime;
void
plconfigtime( PLFLT scale, PLFLT offset1, PLFLT offset2, PLINT ccontrol, PLBOOL ifbtime_offset, PLINT year, PLINT month, PLINT day, PLINT hour, PLINT min, PLFLT sec );
-%feature( "docstring", "Draw a contour plot." ) plcont;
void
plcont( PLFLT **Matrix, PLINT nx, PLINT ny, PLINT kx, PLINT lx,
PLINT ky, PLINT ly, PLFLT *Array, PLINT n,
@@ -340,181 +319,138 @@
PLPointer SWIG_OBJECT_DATA );
-%feature( "docstring", "Calculate continuous time from broken-down time for current stream." ) plctime;
void
plctime( PLINT year, PLINT month, PLINT day, PLINT hour, PLINT min, PLFLT sec, PLFLT *OUTPUT );
-%feature( "docstring", "Copy state parameters from the reference stream to the current stream." ) plcpstrm;
void
plcpstrm( PLINT iplsr, PLBOOL flags );
-%feature( "docstring", "End a plotting session for all open streams." ) plend;
void
plend( void );
-%feature( "docstring", "End a plotting session for the current stream only." ) plend1;
void
plend1( void );
-%feature( "docstring", "Simple interface for defining viewport and window." ) plenv;
void
plenv( PLFLT xmin, PLFLT xmax, PLFLT ymin, PLFLT ymax,
PLINT just, PLINT axis );
-%feature( "docstring", "Simple interface for defining viewport and window." ) plenv0;
void
plenv0( PLFLT xmin, PLFLT xmax, PLFLT ymin, PLFLT ymax,
PLINT just, PLINT axis );
-%feature( "docstring", "End current page. Should only be used with plbop()." ) pleop;
void
pleop( void );
-%feature( "docstring", "Plot horizontal error bars (xmin(i),y(i)) to (xmax(i),y(i))." ) plerrx;
void
plerrx( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLFLT *ArrayCk );
-%feature( "docstring", "Plot vertical error bars (x,ymin(i)) to (x(i),ymax(i))." ) plerry;
void
plerry( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLFLT *ArrayCk );
-%feature( "docstring", "Advance to the next family file on the next new page." ) plfamadv;
void
plfamadv( void );
-%feature( "docstring", "Pattern fills the polygon bounded by the input points." ) plfill;
void
plfill( PLINT n, PLFLT *Array, PLFLT *ArrayCk );
-%feature( "docstring", "Pattern fills the 3d polygon bounded by the input points." ) plfill3;
void
plfill3( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLFLT *ArrayCk );
-%feature( "docstring", "Renders linear gradient for the polygon bounded by the input points." ) plgradient;
void
plgradient( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLFLT angle );
-%feature( "docstring", "Flush the output stream. Use sparingly, if at all." ) plflush;
void
plflush( void );
-%feature( "docstring", "Set the global font flag to 'ifont'." ) plfont;
void
plfont( PLINT ifont );
-%feature( "docstring", "Load specified font set." ) plfontld;
void
plfontld( PLINT fnt );
-%feature( "docstring", "Get character default height and current (scaled) height." ) plgchr;
void
plgchr( PLFLT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Get 8 bit RGB values for given color from color map 0." ) plgcol0;
void
plgcol0( PLINT icol0, PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT );
-%feature( "docstring", "Get 8 bit RGB + alpha values for given color from color map 0." ) plgcol0a;
void
plgcol0a( PLINT icol0, PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Get 8-bit RGB background color." ) plgcolbg;
void
plgcolbg( PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT );
-%feature( "docstring", "Get 8-bit RGB + alpha background color." ) plgcolbga;
void
plgcolbga( PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Get the current compression setting." ) plgcompression;
void
plgcompression( PLINT *OUTPUT );
-%feature( "docstring", "Get the current device (keyword) name." ) plgdev;
void
plgdev( char *OUTPUT );
-%feature( "docstring", "Retrieve current window into device space." ) plgdidev;
void
plgdidev( PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Get plot orientation." ) plgdiori;
void
plgdiori( PLFLT *OUTPUT );
-%feature( "docstring", "Retrieve current window into plot space." ) plgdiplt;
void
plgdiplt( PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Get family file parameters." ) plgfam;
void
plgfam( PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT );
-%feature( "docstring", "Get FCI (font characterization integer)." ) plgfci;
void
plgfci( PLUNICODE *OUTPUT );
-%feature( "docstring", "Get the (current) output file name." ) plgfnam;
void
plgfnam( char *OUTPUT );
-%feature( "docstring", "Get the current font family, style and weight." ) plgfont;
void
plgfont( PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT );
-%feature( "docstring", "Get the (current) run level." ) plglevel;
void
plglevel( PLINT *OUTPUT );
-%feature( "docstring", "Get output device parameters." ) plgpage;
void
plgpage( PLFLT *OUTPUT, PLFLT *OUTPUT,
PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT, PLINT *OUTPUT );
-%feature( "docstring", "Switch to graphics screen." ) plgra;
void
plgra( void );
-%feature( "docstring", "Grid irregular sample data." ) plgriddata;
void
plgriddata( PLFLT *Array, PLFLT *ArrayCk, PLFLT *ArrayCk, PLINT n,
PLFLT *ArrayX, PLINT nx, PLFLT *ArrayY, PLINT ny,
PLFLT **OutMatrixCk, PLINT type, PLFLT data );
-%feature( "docstring", "Get subpage boundaries in absolute coordinates." ) plgspa;
void
plgspa( PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Get current stream number." ) plgstrm;
void
plgstrm( PLINT *OUTPUT );
-%feature( "docstring", "Get current library version number." ) plgver;
void
plgver( char *OUTPUT );
-%feature( "docstring", "Get viewport boundaries in normalized device coordinates." ) plgvpd;
void
plgvpd( PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Get viewport boundaries in world coordinates." ) plgvpw;
void
plgvpw( PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Get x axis labeling parameters." ) plgxax;
void
plgxax( PLINT *OUTPUT, PLINT *OUTPUT );
-%feature( "docstring", "Get y axis labeling parameters." ) plgyax;
void
plgyax( PLINT *OUTPUT, PLINT *OUTPUT );
-%feature( "docstring", "Get z axis labeling parameters." ) plgzax;
void
plgzax( PLINT *OUTPUT, PLINT *OUTPUT );
-%feature( "docstring", "Draw histogram." ) plhist;
void
plhist( PLINT n, PLFLT *Array, PLFLT datmin, PLFLT datmax,
PLINT nbin, PLINT oldwin );
@@ -523,28 +459,22 @@
// Deprecated function that we no longer want to propagate to the
// python API.
-%feature( "docstring", "Set current color (map 0) by hue, lightness, and saturation." ) plhls;
void
plhls( PLFLT h, PLFLT l, PLFLT s );
#endif
-%feature( "docstring", "Transform from HLS to RGB form of colours." ) plhlsrgb;
void
plhlsrgb( PLFLT h, PLFLT l, PLFLT s, PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Initialize PLplot, using preset or default options." ) plinit;
void
plinit( void );
-%feature( "docstring", "Draw a line segment from (x1, y1) to (x2, y2)." ) pljoin;
void
pljoin( PLFLT x1, PLFLT y1, PLFLT x2, PLFLT y2 );
-%feature( "docstring", "Label graphs." ) pllab;
void
pllab( const char *xlabel, const char *ylabel, const char *tlabel );
-%feature( "docstring", "Create a discrete annotated legend using boxes, lines, and/or lines of symbols." ) pllegend;
void
pllegend( PLFLT *OUTPUT, PLFLT *OUTPUT,
PLINT opt, PLFLT x, PLFLT y, PLFLT plot_width,
@@ -561,249 +491,191 @@
const PLINT *ArrayCkNull, const PLFLT *ArrayCkNull,
const PLINT *ArrayCkNull, const char **ArrayCk );
-%feature( "docstring", "Create a continous colorbar using an image, shade, or gradient with an optional axis label." ) plcolorbar;
void
plcolorbar( PLINT opt, PLFLT x, PLFLT y, PLFLT length, PLFLT width,
PLFLT ticks, PLFLT sub_ticks,
const char *axis_opts, const char *label,
PLINT n, PLFLT *Array, PLFLT *ArrayCk );
-%feature( "docstring", "Set position of the light source." ) pllightsource;
void
pllightsource( PLFLT x, PLFLT y, PLFLT z );
-%feature( "docstring", "Draw line segments connecting a series of points." ) plline;
void
plline( PLINT n, PLFLT *Array, PLFLT *ArrayCk );
-%feature( "docstring", "Draw a line in 3 space." ) plline3;
void
plline3( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLFLT *ArrayCk );
-%feature( "docstring", "Set line style." ) pllsty;
void
pllsty( PLINT lin );
-%feature( "docstring", "Plot a 3-d mesh representation of z[x][y]." ) plmesh;
void
plmesh( PLFLT *ArrayX, PLFLT *ArrayY, PLFLT **MatrixCk,
PLINT nx, PLINT ny, PLINT opt );
-%feature( "docstring", "Plot a 3-d contoured mesh representation of the function z[x][y]." ) plmeshc;
void
plmeshc( PLFLT *ArrayX, PLFLT *ArrayY, PLFLT **MatrixCk,
PLINT nx, PLINT ny, PLINT opt, PLFLT *Array, PLINT n );
-%feature( "docstring", "Create a new stream and makes it the default." ) plmkstrm;
void
plmkstrm( PLINT *OUTPUT );
-%feature( "docstring", "Print \"text\" at specified position relative to viewport." ) plmtex;
void
plmtex( const char *side, PLFLT disp, PLFLT pos, PLFLT just,
const char *text );
-%feature( "docstring", "Print \"text\" at specified position relative to 3D viewport." ) plmtex3;
void
plmtex3( const char *side, PLFLT disp, PLFLT pos, PLFLT just,
const char *text );
-%feature( "docstring", "Plot a 3-d representation of the function z[x][y]." ) plot3d;
void
plot3d( PLFLT *ArrayX, PLFLT *ArrayY, PLFLT **MatrixCk,
PLINT nx, PLINT ny, PLINT opt, PLBOOL side );
-%feature( "docstring", "Plot a 3-d contoured representation of the function z[x][y]." ) plot3dc;
void
plot3dc( PLFLT *ArrayX, PLFLT *ArrayY, PLFLT **MatrixCk,
PLINT nx, PLINT ny, PLINT opt, PLFLT *Array, PLINT n );
-%feature( "docstring", "Plot a 3-d contoured representation of the function z[x][y] with limits on the y index." ) plot3dcl;
void
plot3dcl( PLFLT *ArrayX, PLFLT *ArrayY, PLFLT **MatrixCk,
PLINT nx, PLINT ny, PLINT opt, PLFLT *Array, PLINT n,
PLINT ixstart, PLINT n, PLINT *Array, PLINT *ArrayCk );
-%feature( "docstring", "Plot a 3-d contoured surface representation of the function z[x][y]." ) plsurf3d;
void
plsurf3d( PLFLT *ArrayX, PLFLT *ArrayY, PLFLT **MatrixCk,
PLINT nx, PLINT ny, PLINT opt, PLFLT *Array, PLINT n );
-%feature( "docstring", "Plot a 3-d contoured surface representation of the function z[x][y] with limits on the y index." ) plsurf3dl;
void
plsurf3dl( PLFLT *ArrayX, PLFLT *ArrayY, PLFLT **MatrixCk,
PLINT nx, PLINT ny, PLINT opt, PLFLT *Array, PLINT n,
PLINT ixstart, PLINT n, PLINT *Array, PLINT *ArrayCk );
-%feature( "docstring", "Process options list using current options info." ) plparseopts;
PLINT
plparseopts( int *p_argc, const char **argv, PLINT mode );
-%feature( "docstring", "Set fill pattern directly." ) plpat;
void
plpat( PLINT n, PLINT *Array, PLINT *ArrayCk );
-%feature( "docstring", "Plot array y against x for n points using ASCII code \"code\"." ) plpoin;
void
plpoin( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLINT code );
-%feature( "docstring", "Draw a series of points in 3 space." ) plpoin3;
void
plpoin3( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLFLT *ArrayCk, PLINT code );
-%feature( "docstring", "Draw a polygon in 3 space." ) plpoly3;
void
plpoly3( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLFLT *ArrayCk, PLBOOL *ArrayCkMinus1,
PLBOOL flag );
-%feature( "docstring", "Set the floating point precision (in number of places) in numeric labels." ) plprec;
void
plprec( PLINT setp, PLINT prec );
-%feature( "docstring", "Set fill pattern, using one of the predefined patterns." ) plpsty;
void
plpsty( PLINT patt );
-%feature( "docstring", "Print \"text\" at world cooordinates (x,y)." ) plptex;
void
plptex( PLFLT x, PLFLT y, PLFLT dx, PLFLT dy, PLFLT just, const char *text );
-%feature( "docstring", "Print \"text\" at world cooordinates (x,y,z)." ) plptex3;
void
plptex3( PLFLT x, PLFLT y, PLFLT z, PLFLT dx, PLFLT dy, PLFLT dz, PLFLT sx, PLFLT sy, PLFLT sz, PLFLT just, const char *text );
-%feature( "docstring", "Return a random number in the range [0,1]." ) plrandd;
PLFLT
plrandd();
-%feature( "docstring", "Replay contents of plot buffer to current device/file." ) plreplot;
void
plreplot( void );
-%feature( "docstring", "Transform from RGB to HLS form of colours." ) plrgbhls;
void
plrgbhls( PLFLT r, PLFLT g, PLFLT b, PLFLT *OUTPUT, PLFLT *OUTPUT, PLFLT *OUTPUT );
-%feature( "docstring", "Set character height." ) plschr;
void
plschr( PLFLT def, PLFLT scale );
-%feature( "docstring", "Set color map 0 colors by 8 bit RGB values." ) plscmap0;
void
plscmap0( PLINT *Array, PLINT *ArrayCk, PLINT *ArrayCk, PLINT n );
-%feature( "docstring", "Set color map 0 colors by 8 bit RGB + alpha values." ) plscmap0a;
void
plscmap0a( PLINT *Array, PLINT *ArrayCk, PLINT *ArrayCk, PLFLT *ArrayCk, PLINT n );
-%feature( "docstring", "Set number of colors in cmap 0." ) plscmap0n;
void
plscmap0n( PLINT ncol0 );
-%feature( "docstring", "Set color map 1 colors by 8 bit RGB values." ) plscmap1;
void
plscmap1( PLINT *Array, PLINT *ArrayCk, PLINT *ArrayCk, PLINT n );
-%feature( "docstring", "Set color map 1 colors by 8 bit RGB + alpha values." ) plscmap1a;
void
plscmap1a( PLINT *Array, PLINT *ArrayCk, PLINT *ArrayCk, PLFLT *ArrayCk, PLINT n );
-%feature( "docstring", "Set color map 1 colors using a piece-wise linear relationship between intensity [0,1] (cmap 1 index) and position in HLS or
-RGB color space." ) plscmap1l;
void
plscmap1l( PLBOOL itype, PLINT n, PLFLT *Array,
PLFLT *ArrayCk, PLFLT *ArrayCk, PLFLT *ArrayCk,
PLBOOL *ArrayCkMinus1Null );
-%feature( "docstring", "Set color map 1 colors using a piece-wise linear relationship between intensity [0,1] (cmap 1 index) and position in HLS or
-RGB color space + alpha value." ) plscmap1la;
void
plscmap1la( PLBOOL itype, PLINT n, PLFLT *Array,
PLFLT *ArrayCk, PLFLT *ArrayCk, PLFLT *ArrayCk, PLFLT *ArrayCk,
PLBOOL *ArrayCkMinus1Null );
-%feature( "docstring", "Set number of colors in cmap 1." ) plscmap1n;
void
plscmap1n( PLINT ncol1 );
-%feature( "docstring", "Set 8-bit RGB value in cmap 0." ) plscol0;
void
plscol0( PLINT icol0, PLINT r, PLINT g, PLINT b );
-%feature( "docstring", "Set 8-bit RGB + alpha value in cmap 0." ) plscol0a;
void
plscol0a( PLINT icol0, PLINT r, PLINT g, PLINT b, PLFLT a );
-%feature( "docstring", "Set the background color using 8-bit RGB value." ) plscolbg;
void
plscolbg( PLINT r, PLINT g, PLINT b );
-%feature( "docstring", "Set the background color using 8-bit RGB + alpha value." ) plscolbga;
void
plscolbga( PLINT r, PLINT g, PLINT b, PLFLT a );
-%feature( "docstring", "Globally turn color output on/off." ) plscolor;
void
plscolor( PLINT color );
-%feature( "docstring", "Set the compression level." ) plscompression;
void
plscompression( PLINT compression );
-%feature( "docstring", "Set the device (keyword) name." ) plsdev;
void
plsdev( const char *devname );
-%feature( "docstring", "Set window into device space using margin, aspect ratio, and justification." ) plsdidev;
void
plsdidev( PLFLT mar, PLFLT aspect, PLFLT jx, PLFLT jy );
-%feature( "docstring", "Set up transformation from metafile coordinates." ) plsdimap;
void
plsdimap( PLINT dimxmin, PLINT dimxmax, PLINT dimymin, PLINT dimymax,
PLFLT dimxpmm, PLFLT dimypmm );
-%feature( "docstring", "Set plot orientation, specifying rotation in units of pi/2." ) plsdiori;
void
plsdiori( PLFLT rot );
-%feature( "docstring", "Set window into plot space." ) plsdiplt;
void
plsdiplt( PLFLT xmin, PLFLT ymin, PLFLT xmax, PLFLT ymax );
-%feature( "docstring", "Set window into plot space incrementally (zoom)." ) plsdiplz;
void
plsdiplz( PLFLT xmin, PLFLT ymin, PLFLT xmax, PLFLT ymax );
-%feature( "docstring", "Seed the random number generator." ) plseed;
void
plseed( unsigned int s );
-%feature( "docstring", "Set the escape character for text strings." ) plsesc;
void
plsesc( char esc );
-%feature( "docstring", "Process input strings, treating them as an option and argument pair. The first is for the external API, the second the work routine declared here for backward compatibility." ) plsetopt;
PLINT
plsetopt( const char *opt, const char *optarg );
-%feature( "docstring", "Set family file parameters." ) plsfam;
void
plsfam( PLINT fam, PLINT num, PLINT bmax );
-%feature( "docstring", "Set FCI (font characterization integer)." ) plsfci;
void
plsfci( PLUNICODE fci );
-%feature( "docstring", "Set the output file name." ) plsfnam;
void
plsfnam( const char *fnam );
-%feature( "docstring", "Set the current font family, style and weight." ) plsfont;
void
plsfont( PLINT family, PLINT style, PLINT weight );
-%feature( "docstring", "Shade regions with continuous range of colours." ) plshades;
void
plshades( PLFLT **Matrix, PLINT nx, PLINT ny, defined_func df,
PLFLT xmin, PLFLT xmax, PLFLT ymin, PLFLT ymax,
@@ -813,7 +685,6 @@
pltr_func pltr,
PLPointer SWIG_OBJECT_DATA );
-%feature( "docstring", "Shade region with discrete colour, pattern fill." ) plshade;
void
plshade( PLFLT **Matrix, PLINT nx, PLINT ny, defined_func df,
PLFLT left, PLFLT right, PLFLT bottom, PLFLT top,
@@ -825,90 +696,70 @@
pltr_func pltr,
PLPointer SWIG_OBJECT_DATA );
-%feature( "docstring", "Set up a user-provided custom labeling function" ) plslabelfunc;
void
plslabelfunc( label_func lf, PLPointer data );
-%feature( "docstring", "Set up lengths of major tick marks." ) plsmaj;
void
plsmaj( PLFLT def, PLFLT scale );
#if defined ( PYTHON_HAVE_PYBUFFER ) && defined ( SWIG_PYTHON )
-%feature( "docstring", "Set the RGB memory area to be plotted (with the 'mem' or 'memcairo' drivers)." ) plsmem;
void
plsmem( PLINT maxx, PLINT maxy, void *plotmem );
-%feature( "docstring", "Set the RGBA memory area to be plotted (with the 'memcairo' driver)." ) plsmema;
void
plsmema( PLINT maxx, PLINT maxy, void *plotmem );
#endif
-%feature( "docstring", "Set up lengths of minor tick marks." ) plsmin;
void
plsmin( PLFLT def, PLFLT scale );
-%feature( "docstring", "Set orientation. Must be done before calling plinit." ) plsori;
void
plsori( PLINT ori );
-%feature( "docstring", "Set output device parameters. Usually ignored by the driver." ) plspage;
void
plspage( PLFLT xp, PLFLT yp, PLINT xleng, PLINT yleng,
PLINT xoff, PLINT yoff );
-%feature( "docstring", "Set the color map 0 colors using a cmap0 color palette file." ) plspal0;
void
plspal0( const char *filename );
-%feature( "docstring", "Set the color map 1 colors using a cmap1 color palette file." ) plspal1;
void
plspal1( const char *filename, PLBOOL interpolate );
-%feature( "docstring", "Set the pause (on end-of-page) status." ) plspause;
void
plspause( PLBOOL pause );
-%feature( "docstring", "Set stream number." ) plsstrm;
void
plsstrm( PLINT strm );
-%feature( "docstring", "Set the number of subwindows in x and y." ) plssub;
void
plssub( PLINT nx, PLINT ny );
-%feature( "docstring", "Set symbol height." ) plssym;
void
plssym( PLFLT def, PLFLT scale );
-%feature( "docstring", "Initialize PLplot, passing in the windows/page settings." ) plstar;
void
plstar( PLINT nx, PLINT ny );
-%feature( "docstring", "Initialize PLplot, passing the device name and windows/page settings." ) plstart;
void
plstart( const char *devname, PLINT nx, PLINT ny );
#if !defined ( SWIG_LUA ) && !defined ( SWIG_OCTAVE )
-%feature( "docstring", "Set the coordinate transform." ) plstransform;
void
plstransform( ct_func ctf, PLPointer data );
#endif
-%feature( "docstring", "Prints out the same string repeatedly at the n points in world coordinates given by the x and y arrays. Supersedes plpoin and plsymbol for the case where text refers to a unicode glyph either directly as UTF-8 or indirectly via the standard text escape sequences allowed for PLplot input strings." ) plstring;
void
plstring( PLINT n, PLFLT *Array, PLFLT *ArrayCk, const char *string );
-%feature( "docstring", "Prints out the same string repeatedly at the n 3D points in world coordinates given by the x, y, and z arrays. Supersedes plpoin3 for the case where text refers to a unicode glyph either directly as UTF-8 or indirectly via the standard text escape sequences allowed for PLplot input strings." ) plstring3;
void
plstring3( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLFLT *ArrayCk, const char *string );
-%feature( "docstring", "Add a point to a stripchart." ) plstripa;
void
plstripa( PLINT id, PLINT pen, PLFLT x, PLFLT y );
-%feature( "docstring", "Create 1d stripchart." ) plstripc;
void
plstripc( PLINT *OUTPUT, const char *xspec, const char *yspec,
PLFLT xmin, PLFLT xmax, PLFLT xjump, PLFLT ymin, PLFLT ymax,
@@ -918,83 +769,64 @@
PLINT *Array, PLINT *ArrayCk, const char *legline[4],
const char *labx, const char *laby, const char *labtop );
-%feature( "docstring", "Deletes and releases memory used by a stripchart." ) plstripd;
void
plstripd( PLINT id );
-%feature( "docstring", "Set up a new line style." ) plstyl;
void
plstyl( PLINT n, PLINT *Array, PLINT *ArrayCk );
-%feature( "docstring", "Set vector arrow style." ) plsvect;
void
plsvect( PLFLT *Array, PLFLT *ArrayCk, PLINT n, PLBOOL fill );
-%feature( "docstring", "Set the edges of the viewport to the specified absolute coordinates." ) plsvpa;
void
plsvpa( PLFLT xmin, PLFLT xmax, PLFLT ymin, PLFLT ymax );
-%feature( "docstring", "Set x axis labeling parameters." ) plsxax;
void
plsxax( PLINT digmax, PLINT digits );
-%feature( "docstring", "Set y axis labeling parameters." ) plsyax;
void
plsyax( PLINT digmax, PLINT digits );
-%feature( "docstring", "Plot array y against x for n points using Hershey symbol \"code\"." ) plsym;
void
plsym( PLINT n, PLFLT *Array, PLFLT *ArrayCk, PLINT code );
-%feature( "docstring", "Set z axis labeling parameters." ) plszax;
void
plszax( PLINT digmax, PLINT digits );
-%feature( "docstring", "Switch to text screen." ) pltext;
void
pltext( void );
-%feature( "docstring", "Set the format for date / time labels" ) pltimefmt;
void
pltimefmt( const char *fmt );
-%feature( "docstring", "Sets the edges of the viewport with the given aspect ratio, leaving room for labels." ) plvasp;
void
plvasp( PLFLT aspect );
-%feature( "docstring", "Plot vectors." ) plvect;
void
plvect( PLFLT **Matrix, PLFLT **MatrixCk, PLINT nx, PLINT ny, PLFLT scale,
pltr_func pltr,
PLPointer SWIG_OBJECT_DATA );
-%feature( "docstring", "Create the largest viewport of the specified aspect ratio that fits within the specified normalized subpage coordinates." ) plvpas;
void
plvpas( PLFLT xmin, PLFLT xmax, PLFLT ymin, PLFLT ymax, PLFLT aspect );
-%feature( "docstring", "Create a viewport with the specified normalized subpage coordinates." ) plvpor;
void
plvpor( PLFLT xmin, PLFLT xmax, PLFLT ymin, PLFLT ymax );
-%feature( "docstring", "Define a \"standard\" viewport with seven character heights for the left margin and four character heights everywhere else." ) plvsta;
void
plvsta( void );
-%feature( "docstring", "Set up a window for three-dimensional plotting." ) plw3d;
void
plw3d( PLFLT basex, PLFLT basey, PLFLT height, PLFLT xmin0,
PLFLT xmax0, PLFLT ymin0, PLFLT ymax0, PLFLT zmin0,
PLFLT zmax0, PLFLT alt, PLFLT az );
-%feature( "docstring", "Set pen width." ) plwid;
void
plwid( PLINT width );
-%feature( "docstring", "Set up world coordinates of the viewport boundaries (2d plots)." ) plwind;
void
plwind( PLFLT xmin, PLFLT xmax, PLFLT ymin, PLFLT ymax );
-%feature( "docstring", "Set xor mode; mode = 1-enter, 0-leave, status = 0 if not interactive device." ) plxormod;
void
plxormod( PLBOOL mode, PLBOOL *OUTPUT );
@@ -1003,11 +835,9 @@
// Deprecated functions that are in common API, but we don't want to
// propagate them to the python API.
-%feature( "docstring", "Set line color by red, green, blue values in range from 0. to 1." ) plrgb;
void
plrgb( PLFLT r, PLFLT g, PLFLT b );
-%feature( "docstring", "Set line color by 8 bit RGB values." ) plrgb1;
void
plrgb1( PLINT r, PLINT g, PLINT b );
@@ -1132,7 +962,6 @@
#if 0
// Cannot get this to work since plsError is not simply an output
// of an internal integer and character string.
-%feature( "docstring", "Set the variables to be used for storing error info." ) plsError;
void
plsError( PLINT *OUTPUT, char *OUTPUT );
#endif
@@ -1286,7 +1115,6 @@
// Wait for graphics input event and translate to world coordinates
-%feature( "docstring", "Wait for graphics input event and translate to world coordinates." ) plGetCursor;
PLINT
plGetCursor( PLGraphicsIn *gin );
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
