[Plplot-cvs] SF.net SVN: plplot:[11634] trunk/src/pllegend.c

[<ai...@us...>]

Revision: 11634
          http://plplot.svn.sourceforge.net/plplot/?rev=11634&view=rev
Author:   airwin
Date:     2011-03-16 21:48:33 +0000 (Wed, 16 Mar 2011)

Log Message:
-----------
Tweak doxygen documentation of the pllegend procedure.  As far as I
know, this finishes the doxygen documentation of this procedure and
everything else in pllegend.c except for plcolorbar where more changes
are expected.

Modified Paths:
--------------
    trunk/src/pllegend.c

Modified: trunk/src/pllegend.c
===================================================================
--- trunk/src/pllegend.c	2011-03-16 21:45:38 UTC (rev 11633)
+++ trunk/src/pllegend.c	2011-03-16 21:48:33 UTC (rev 11634)
@@ -419,6 +419,7 @@
 //! legend.  If the PL_LEGEND_ROW_MAJOR bit is set and both (of the
 //! possibly internally transformed) nrow > 1 and ncolumn > 1, then
 //! plot the resulting array of legend entries in row-major order.
+//! Otherwise, plot the legend entries in column-major order.
 //! @param x X offset of the legend position in adopted coordinates
 //! from the specified standard position of the legend.  For positive
 //! x, the direction of motion away from the standard position is
@@ -477,8 +478,8 @@
 //! @param text_colors Array of nlegend text colors (cmap0 indices).
 //! @param text Array of nlegend pointers to null-terminated text
 //! annotation strings.  Like other PLplot strings specified by the
-//! user, UTF-8 or its ascii subset may be used in the strings, and
-//! the strings may include any of the PLplot text escapes.
+//! user, the string must be UTF-8 (including its ascii subset) and
+//! may include any of the PLplot text escapes.
 //! @param box_colors Array of nlegend colors (cmap0 indices) for
 //! the discrete colored boxes (PL_LEGEND_COLOR_BOX).
 //! @param box_patterns Array of nlegend patterns (plpsty indices)
@@ -502,8 +503,8 @@
 //! @param symbols Array of nlegend pointers to null-terminated
 //! strings which represent the glyph for the symbol to be plotted
 //! (PL_LEGEND_SYMBOL).  Like other PLplot strings specified by the
-//! user, UTF-8 or its ascii subset may be used in the strings, and
-//! the strings may include any of the PLplot text escapes.
+//! user, the string must be UTF-8 (including its ascii subset) and
+//! may include any of the PLplot text escapes.
 //!
 
 void


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.