Menu
▾
▴
[Plplot-cvs] SF.net SVN: plplot:[12508] trunk/src
|
From: <ai...@us...> - 2013-09-18 18:51:06
|
Revision: 12508
http://sourceforge.net/p/plplot/code/12508
Author: airwin
Date: 2013-09-18 18:51:03 +0000 (Wed, 18 Sep 2013)
Log Message:
-----------
Update doxygen documentation of PL_UNUSED function parameters to
eliminate doxygen warning messages concerning such parameters and to
produce reasonable looking doxygen results for those parameters.
Modified Paths:
--------------
trunk/src/pdfutils.c
trunk/src/plargs.c
trunk/src/plot3d.c
Modified: trunk/src/pdfutils.c
===================================================================
--- trunk/src/pdfutils.c 2013-09-18 07:26:10 UTC (rev 12507)
+++ trunk/src/pdfutils.c 2013-09-18 18:51:03 UTC (rev 12508)
@@ -1122,8 +1122,7 @@
//!
//! @param f The [][] to the storage.
//! @param nx Size of the grid in x.
-//! @param ny Size of the grid in y (not used).
-//!
+//! @param PL_UNUSED( ny) Not used.
//--------------------------------------------------------------------------
void
Modified: trunk/src/plargs.c
===================================================================
--- trunk/src/plargs.c 2013-09-18 07:26:10 UTC (rev 12507)
+++ trunk/src/plargs.c 2013-09-18 18:51:03 UTC (rev 12508)
@@ -1543,9 +1543,9 @@
//! Performs appropriate action for option "h":
//! Issues help message
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 2.
//!
@@ -1566,9 +1566,9 @@
//! Performs appropriate action for option "v":
//! Issues version message
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 2.
//!
@@ -1589,9 +1589,9 @@
//! Performs appropriate action for option "verbose":
//! Turn on verbosity flag
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1610,9 +1610,9 @@
//! Performs appropriate action for option "debug":
//! Turn on debugging flag
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1632,9 +1632,9 @@
//! Performs appropriate action for option "hack":
//! Enables driver-specific hack(s)
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1653,9 +1653,9 @@
//! Performs appropriate action for option "dev":
//! Sets output device keyword
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg The name of the output device.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1674,9 +1674,9 @@
//! Performs appropriate action for option "o":
//! Sets output file name
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg The file family name.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1695,9 +1695,9 @@
//! Performs appropriate action for option "mar":
//! Sets relative margin width
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Plot margin width.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1716,9 +1716,9 @@
//! Performs appropriate action for option "a":
//! Sets plot aspect ratio on page
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Plot aspect ratio.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1737,9 +1737,9 @@
//! Performs appropriate action for option "jx":
//! Sets relative justification in x
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Plot relative justification in x(?)
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1758,9 +1758,9 @@
//! Performs appropriate action for option "jy":
//! Sets relative justification in y
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Plot relative justification in y(?)
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1779,9 +1779,9 @@
//! Performs appropriate action for option "ori":
//! Sets orientation
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Plot orientation.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1800,9 +1800,9 @@
//! Performs appropriate action for option "freeaspect":
//! Allow aspect ratio to adjust to orientation swaps.
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1835,9 +1835,9 @@
//! bit of code from ps.c that has to do with pls->portrait to the
//! appropriate driver file.
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1856,9 +1856,9 @@
//! Performs appropriate action for option "width":
//! Sets pen width
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Plot pen width.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1893,9 +1893,9 @@
//! -bg ff0000 (set background to red with an alpha value of 1.0)
//! -bg ff0000_0.1 (set background to red with an alpha value of 0.1
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Background RGB color in hex.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1976,9 +1976,9 @@
//! Performs appropriate action for option "ncol0":
//! Sets number of colors to allocate in cmap 0 (upper bound).
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Number of color map 0 colors.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -1997,9 +1997,9 @@
//! Performs appropriate action for option "ncol1":
//! Sets number of colors to allocate in cmap 1 (upper bound).
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Number of color map 1 colors.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2018,9 +2018,9 @@
//! Performs appropriate action for option "wplt":
//! Sets (zoom) window into plot (e.g. "0,0,0.5,0.5")
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Zoom setting.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2065,9 +2065,9 @@
//! Get driver specific options in the form <option[=value]>[,option[=value]]*
//! If "value" is not specified, it defaults to "1".
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg The driver specific option.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2155,9 +2155,9 @@
//! Performs appropriate action for option "fam":
//! Enables family output files
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2185,9 +2185,9 @@
//! Note case of the trailing suffix doesn't matter.
//! If no suffix, defaults to MB.
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Family size setting.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2243,9 +2243,9 @@
//! Performs appropriate action for option "fbeg":
//! Starts with the specified family member number.
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Number of the first plot.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2265,9 +2265,9 @@
//! Performs appropriate action for option "finc":
//! Specify increment between family members.
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Amount to increment the plot number between plots.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2287,9 +2287,9 @@
//! Performs appropriate action for option "fflen":
//! Specify minimum field length for family member number.
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Size of the family number field (e.g. "1", "01", "001" ?)
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2309,9 +2309,9 @@
//! Performs appropriate action for option "np":
//! Disables pause between pages
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2330,9 +2330,9 @@
//! Performs appropriate action for option "nopixmap":
//! Disables use of pixmaps in X drivers
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2351,9 +2351,9 @@
//! Performs appropriate action for option "db":
//! Double buffer X output (update only done on eop or Expose)
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2372,9 +2372,9 @@
//! Performs appropriate action for option "bufmax":
//! Sets size of data buffer for tk driver
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Size of the data buffer for the tk driver.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2393,9 +2393,9 @@
//! Performs appropriate action for option "server_name":
//! Sets main window name of server (Tcl/TK driver only)
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg The name of the main window.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2414,9 +2414,9 @@
//! Performs appropriate action for option "plserver":
//! Sets name to use when invoking server (Tcl/TK driver only)
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Name of Tcl/TK server (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2435,9 +2435,9 @@
//! Performs appropriate action for option "plwindow":
//! Sets PLplot window name
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Name of the window.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2460,9 +2460,9 @@
//! Performs appropriate action for option "auto_path":
//! Sets additional directories to autoload
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Additional directories to add the the load path (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2481,9 +2481,9 @@
//! Performs appropriate action for option "px":
//! Set packing in x
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg X packing (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2502,9 +2502,9 @@
//! Performs appropriate action for option "py":
//! Set packing in y
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Y packing (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2527,9 +2527,9 @@
//! -XOFF+YOFF, and -XOFF-YOFF. Some examples are the following:
//! -geometry 400x300, -geometry -100+200, and -geometry 400x300-100+200.
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Plot geometry descriptor.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2620,9 +2620,9 @@
//
//! File name for plserver tk_file option
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Tk file name.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2650,9 +2650,9 @@
//! e.g., "-dpi 1200"
//! Will set both X and Y dpi to 1200 dpi
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg DPI descriptor string.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2698,9 +2698,9 @@
//
//! Sets device compression
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Device compression (?).
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2727,9 +2727,9 @@
//
//! Sets color table 0 based on a cmap0.pal file.
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Name of color map 0 .pal file.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2747,9 +2747,9 @@
//
//! Sets color table 1 based on a cmap1.pal file.
//!
-//! @param opt Not used.
+//! @param PL_UNUSED( opt ) Not used.
//! @param opt_arg Name of a color map 1 .pal file.
-//! @param client_data Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2767,9 +2767,9 @@
//
//! Make PLplot portable to all LC_NUMERIC locales.
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
@@ -2801,9 +2801,9 @@
//! self-intersecting, use the even-odd fill rule rather than the
//! default nonzero fill rule.
//!
-//! @param opt Not used.
-//! @param opt_arg Not used.
-//! @param client_data Not used.
+//! @param PL_UNUSED( opt ) Not used.
+//! @param PL_UNUSED( opt_arg ) Not used.
+//! @param PL_UNUSED( client_data ) Not used.
//!
//! returns 0.
//!
Modified: trunk/src/plot3d.c
===================================================================
--- trunk/src/plot3d.c 2013-09-18 07:26:10 UTC (rev 12507)
+++ trunk/src/plot3d.c 2013-09-18 18:51:03 UTC (rev 12508)
@@ -957,13 +957,11 @@
//! or any bitwise OR'd combination, e.g. "MAG_COLOR | DRAW_LINEX"
//! @param clevel z values at which to draw contours
//! @param nlevel Number of values in clevels
-//! @param ixstart Index of first x coordinate to include in plot
-//! @param ixn Number of x coordinates to include in plot
-//! @param indexymin Array which specifies the min y index for each x
-//! index in range ixstart, ixn.
-//! @param indexymax Array which specifies the max y index for each x
-//! coordinate (following the convention that the upper range limit is one more
-//! than actual index limit) for an x index range of ixstart, ixn.
+//! @param PL_UNUSED( ixstart ) Not used.
+//! @param PL_UNUSED( ixn ) Not used.
+//! @param PL_UNUSED( indexymin ) Not used.
+//! @param PL_UNUSED( indexymax ) Not used.
+//!
//--------------------------------------------------------------------------
void
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
