Menu
▾
▴
[Plplot-cvs] SF.net SVN: plplot:[12507] trunk/doc/docbook/src
|
From: <ai...@us...> - 2013-09-18 07:26:13
|
Revision: 12507
http://sourceforge.net/p/plplot/code/12507
Author: airwin
Date: 2013-09-18 07:26:10 +0000 (Wed, 18 Sep 2013)
Log Message:
-----------
Update API documentation of pllegend and plcolorbar consistent with
the corresponding doxygen documentation of the same functions. I plan
no further changes in this API documentation at the present time.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2013-09-18 07:23:49 UTC (rev 12506)
+++ trunk/doc/docbook/src/api.xml 2013-09-18 07:26:10 UTC (rev 12507)
@@ -3,7 +3,7 @@
api.xml: "The Common API for PLplot" chapter
Copyright (C) 1994 Geoffrey Furnish and Maurice LeBrun
-Copyright (C) 1999-2011 Alan W. Irwin
+Copyright (C) 1999-2013 Alan W. Irwin
Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Rafael Laboissiere
Copyright (C) 2003 Joao Cardoso
Copyright (C) 2004, 2007 Andrew Ross
@@ -649,6 +649,23 @@
<literal>t</literal>: Draws major ticks.
</para>
</listitem>
+ <listitem>
+ <para>
+ <literal>u</literal>: Exactly like "b" except don't draw edge line.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>w</literal>: Exactly like "c" except don't draw edge line.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <literal>x</literal>: Exactly like "t" (including the side effect of
+ the numerical labels for the major ticks) except exclude drawing the
+ major and minor tick marks.
+ </para>
+ </listitem>
</itemizedlist>
</para>
</listitem>
@@ -1082,6 +1099,13 @@
<literal>w</literal>: Exactly like "c" except don't draw edge line.
</para>
</listitem>
+ <listitem>
+ <para>
+ <literal>x</literal>: Exactly like "t" (including the side effect of
+ the numerical labels for the major ticks) except exclude drawing the
+ major and minor tick marks.
+ </para>
+ </listitem>
</itemizedlist>
</para>
</listitem>
@@ -1843,6 +1867,458 @@
</sect1>
+ <sect1 id="plcolorbar" renderas="sect3">
+ <title>
+ <function>plcolorbar</function>: Plot color bar for image, shade or gradient plots
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plcolorbar</function>
+ </funcdef>
+ <paramdef><parameter>p_colorbar_width</parameter></paramdef>
+ <paramdef><parameter>p_colorbar_height</parameter></paramdef>
+ <paramdef><parameter>opt</parameter></paramdef>
+ <paramdef><parameter>position</parameter></paramdef>
+ <paramdef><parameter>x</parameter></paramdef>
+ <paramdef><parameter>y</parameter></paramdef>
+ <paramdef><parameter>x_length</parameter></paramdef>
+ <paramdef><parameter>y_length</parameter></paramdef>
+ <paramdef><parameter>bg_color</parameter></paramdef>
+ <paramdef><parameter>bb_color</parameter></paramdef>
+ <paramdef><parameter>bb_style</parameter></paramdef>
+ <paramdef><parameter>low_cap_color</parameter></paramdef>
+ <paramdef><parameter>high_cap_color</parameter></paramdef>
+ <paramdef><parameter>cont_color</parameter></paramdef>
+ <paramdef><parameter>cont_width</parameter></paramdef>
+ <paramdef><parameter>n_labels</parameter></paramdef>
+ <paramdef><parameter>label_opts</parameter></paramdef>
+ <paramdef><parameter>labels</parameter></paramdef>
+ <paramdef><parameter>naxes</parameter></paramdef>
+ <paramdef><parameter>axis_opts</parameter></paramdef>
+ <paramdef><parameter>ticks</parameter></paramdef>
+ <paramdef><parameter>sub_ticks</parameter></paramdef>
+ <paramdef><parameter>n_values</parameter></paramdef>
+ <paramdef><parameter>values</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Routine for creating a continuous color bar for image, shade, or gradient plots.
+ (See &pllegend; for similar functionality for creating legends with discrete elements).
+ The arguments of plcolorbar provide control over the location
+ and size of the color bar as well as the location and characteristics of
+ the elements (most of which are optional) within that color bar. The
+ resulting color bar is clipped at the boundaries of the current subpage.
+ (N.B. the adopted coordinate system used for some of the parameters is
+ defined in the documentation of the
+ <literal><parameter>position</parameter></literal> parameter.)
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>p_colorbar_width</parameter>
+ (<literal>PLFLT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Pointer to a location which contains (after the call) the
+ labelled and decorated color bar width in adopted coordinates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>p_colorbar_height</parameter>
+ (<literal>PLFLT *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Pointer to a location which contains (after the call) the
+ labelled and decorated color bar height in adopted coordinates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>opt</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ <literal><parameter>opt</parameter></literal> contains
+ bits controlling the overall color bar. The orientation (direction of
+ the maximum value) of the color bar is specified with
+ <literal>PL_ORIENT_RIGHT</literal>, <literal>PL_ORIENT_TOP</literal>,
+ <literal>PL_ORIENT_LEFT</literal>, or
+ <literal>PL_ORIENT_BOTTOM</literal>. If none of those bits are
+ specified, the default orientation is toward the top, i.e., a vertical
+ color bar. If the <literal>PL_COLORBAR_BACKGROUND</literal> bit is
+ set, plot a (semi-transparent) background for the color bar. If the
+ <literal>PL_COLORBAR_BOUNDING_BOX</literal> bit is set, plot a
+ bounding box for the color bar. The type of color bar must be
+ specified with one of <literal>PL_COLORBAR_IMAGE</literal>,
+ <literal>PL_COLORBAR_SHADE</literal>, or
+ <literal>PL_COLORBAR_GRADIENT</literal>. If more than one of those
+ bits is set only the first one in the above list is honored. The
+ position of the (optional) label/title can be specified with
+ <literal>PL_LABEL_RIGHT</literal>, <literal>PL_LABEL_TOP</literal>,
+ <literal>PL_LABEL_LEFT</literal>, or
+ <literal>PL_LABEL_BOTTOM</literal>. If no label position bit is set
+ then no label will be drawn. If more than one of this list of bits is
+ specified, only the first one on the list is honored. End-caps for the
+ color bar can added with <literal>PL_COLORBAR_CAP_LOW</literal> and
+ <literal>PL_COLORBAR_CAP_HIGH</literal>. If a particular color bar cap
+ option is not specified then no cap will be drawn for that end. As a
+ special case for <literal>PL_COLORBAR_SHADE</literal>, the option
+ <literal>PL_COLORBAR_SHADE_LABEL</literal> can be specified. If this
+ option is provided then any tick marks and tick labels will be placed
+ at the breaks between shaded segments. TODO: This should be expanded
+ to support custom placement of tick marks and tick labels at custom
+ value locations for any color bar type.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>position</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ <literal><parameter>position</parameter></literal>
+ contains bits which control the overall position of the
+ color bar and the definition of the adopted coordinates used for
+ positions just like what is done for the position argument for
+ &pllegend;. However, note that the defaults for the position bits
+ (see below) are different than the &pllegend; case. The combination of
+ the <literal>PL_POSITION_LEFT</literal>,
+ <literal>PL_POSITION_RIGHT</literal>,
+ <literal>PL_POSITION_TOP</literal>,
+ <literal>PL_POSITION_BOTTOM</literal>,
+ <literal>PL_POSITION_INSIDE</literal>, and
+ <literal>PL_POSITION_OUTSIDE</literal> bits specifies one of the 16
+ possible standard positions (the 4 corners and centers of the 4 sides
+ for both the inside and outside cases) of the color bar relative to
+ the adopted coordinate system. The corner positions are specified by
+ the appropriate combination of two of the
+ <literal>PL_POSITION_LEFT</literal>,
+ <literal>PL_POSITION_RIGHT</literal>,
+ <literal>PL_POSITION_TOP</literal>, and
+ <literal>PL_POSITION_BOTTOM</literal> bits while the sides are
+ specified by a single value of one of those bits. The adopted
+ coordinates are normalized viewport coordinates if the
+ <literal>PL_POSITION_VIEWPORT</literal> bit is set or normalized
+ subpage coordinates if the <literal>PL_POSITION_SUBPAGE</literal> bit
+ is set. Default position bits: If none of
+ <literal>PL_POSITION_LEFT</literal>,
+ <literal>PL_POSITION_RIGHT</literal>,
+ <literal>PL_POSITION_TOP</literal>, or
+ <literal>PL_POSITION_BOTTOM</literal> are set, then use
+ <literal>PL_POSITION_RIGHT</literal>. If neither of
+ <literal>PL_POSITION_INSIDE</literal> or
+ <literal>PL_POSITION_OUTSIDE</literal> is set, use
+ <literal>PL_POSITION_OUTSIDE</literal>. If neither of
+ <literal>PL_POSITION_VIEWPORT</literal> or
+ <literal>PL_POSITION_SUBPAGE</literal> is set, use
+ <literal>PL_POSITION_VIEWPORT</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>x</parameter>
+ (<literal> PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ X offset of the color bar position in adopted coordinates from the
+ specified standard position of the color bar. For positive x, the
+ direction of motion away from the standard position is inward/outward
+ from the standard corner positions or standard left or right positions
+ if the
+ <literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal>
+ bit is set in <literal><parameter>position</parameter></literal>. For
+ the standard top or bottom positions, the direction of motion is
+ toward positive X.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>y</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Y offset of the color bar position in adopted coordinates from the
+ specified standard position of the color bar. For positive y, the
+ direction of motion away from the standard position is inward/outward
+ from the standard corner positions or standard top or bottom positions
+ if the
+ <literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal>
+ bit is set in <literal><parameter>position</parameter></literal>. For
+ the standard left or right positions, the direction of motion is
+ toward positive Y.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>x_length</parameter>
+ (<literal> PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Length of the body of the color bar in the X direction in
+ adopted coordinates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>y_length</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Length of the body of the color bar in the Y direction in adopted
+ coordinates.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>bg_color</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap0 color of the background for the color bar
+ (<literal>PL_COLORBAR_BACKGROUND</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>bb_color</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap0 color of the bounding-box line for the color bar
+ (<literal>PL_COLORBAR_BOUNDING_BOX</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>bb_style</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The &pllsty; style number for the bounding-box line for the color bar
+ (<literal>PL_COLORBAR_BACKGROUND</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>low_cap_color</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap1 color of the low-end color bar cap, if it is drawn
+ (<literal>PL_COLORBAR_CAP_LOW</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>high_cap_color</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap1 color of the high-end color bar cap, if it is drawn
+ (<literal>PL_COLORBAR_CAP_HIGH</literal>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>cont_color</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ The cmap0 contour color for <literal>PL_COLORBAR_SHADE</literal>
+ plots. This is passed directly to &plshades;, so it will be
+ interpreted according to the design of &plshades;.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>cont_width</parameter>
+ (<literal>PLFLT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Contour width for <literal>PL_COLORBAR_SHADE</literal>
+ plots. This is passed directly to &plshades;, so it will be
+ interpreted according to the design of &plshades;.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>n_labels</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Number of labels to place around the color bar.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>label_opts</parameter>
+ (<literal>const PLINT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Options for each of <parameter>n_labels</parameter> labels.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>labels</parameter>
+ (<literal>const char *const *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ <parameter>n_labels</parameter> text labels for the color bar. No
+ label is drawn if no label position is specified with one of the
+ <literal>PL_COLORBAR_LABEL_RIGHT</literal>,
+ <literal>PL_COLORBAR_LABEL_TOP</literal>,
+ <literal>PL_COLORBAR_LABEL_LEFT</literal>, or
+ <literal>PL_COLORBAR_LABEL_BOTTOM</literal> bits in the corresponding
+ label_opts field.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>n_axes</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Number of axis definitions provided. This value must be greater than
+ 0. It is typically 1 (numerical axis labels are provided for one of
+ the long edges of the color bar), but it can be larger if multiple
+ numerical axis labels for the long edges of the color bar are desired.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>axis_opts</parameter>
+ (<literal>const char *const *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ An array of n_axes axis options (interpreted as for &plbox;) for the
+ color bar's axis definitions.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>ticks</parameter>
+ (<literal>PLFLT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ An array of n_axes values of the spacing of the major tick marks
+ (interpreted as for &plbox;) for the color bar's axis definitions.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>sub_ticks</parameter>
+ (<literal>PLINT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ An array of n_axes values of the number of subticks (interpreted as
+ for &plbox;) for the color bar's axis definitions.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>n_values</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ An array containing the number of elements in each of the
+ <literal><parameter>n_axes</parameter></literal> rows of the
+ two-dimensional <literal><parameter>values</parameter></literal> array.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>values</parameter>
+ (<literal>PLFLT *const *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ A two-dimensional array containing the numeric values for the data
+ range represented by the color bar. For a row index of
+ <literal><parameter>i_axis</parameter></literal> (where 0 <
+ <literal><parameter>i_axis</parameter></literal> <
+ <literal><parameter>n_axes</parameter></literal>), the number of
+ elements in the row is specified by
+ <literal><parameter>n_values</parameter></literal>[<literal><parameter>i_axis</parameter></literal>]. For <literal>PL_COLORBAR_IMAGE</literal> and
+ <literal>PL_COLORBAR_GRADIENT</literal> the number of elements is 2,
+ and the corresponding row elements of the
+ <literal><parameter>values</parameter></literal> array are the minimum
+ and maximum value represented by the colorbar. For
+ <literal>PL_COLORBAR_SHADE</literal>, the number and values of the
+ elements of a row of the
+ <literal><parameter>values</parameter></literal> array is interpreted
+ the same as the <literal><parameter>nlevel</parameter></literal> and
+ <literal><parameter>clevel</parameter></literal> arguments of
+ &plshades;.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form: <function>plcolorbar(p_legend_width, p_legend_height,
+ opt, position, x, y, x_length, y_length, bg_color,
+ bb_color, bb_style, low_cap_color, high_cap_color, cont_color, cont_width, label_opts, labels, axis_opts, ticks, sub_ticks, values)</function>
+ </para>
+
+ <para>
+ This function is used in examples 16 and 33.
+ </para>
+
+ </sect1>
+
<sect1 id="plcont" renderas="sect3">
<title>
<function>plcont</function>: Contour plot
@@ -6375,12 +6851,13 @@
<para>
Routine for creating a discrete plot legend with a plotted
filled box, line, and/or line of symbols for each annotated legend
- entry. The arguments of pllegend provide control over the location
- and size of the legend as well as the location and characteristics of
- the elements (most of which are optional) within that legend. The
- resulting legend is clipped at the boundaries of the current subpage.
- (N.B. the adopted coordinate system used for some of the parameters is
- defined in the documentation of the
+ entry. (See &plcolorbar; for similar functionality for creating
+ continuous color bars.) The arguments of pllegend provide control
+ over the location and size of the legend as well as the location and
+ characteristics of the elements (most of which are optional) within
+ that legend. The resulting legend is clipped at the boundaries of the
+ current subpage. (N.B. the adopted coordinate system used for some of
+ the parameters is defined in the documentation of the
<literal><parameter>position</parameter></literal> parameter.)
</para>
<variablelist>
@@ -6454,22 +6931,32 @@
<listitem>
<para>
<literal><parameter>position</parameter></literal>
- contains bits controlling the overall position of the legend and the
- definition of the adopted coordinates used for positions. The
- combination of the <literal>PL_POSITION_LEFT</literal>,
+ contains bits which control the overall position of the legend and the
+ definition of the adopted coordinates used for positions just like
+ what is done for the position argument for &plcolorbar;. However,
+ note that the defaults for the position bits (see below) are
+ different than the &plcolorbar; case. The combination of the
+ <literal>PL_POSITION_LEFT</literal>,
<literal>PL_POSITION_RIGHT</literal>,
<literal>PL_POSITION_TOP</literal>,
<literal>PL_POSITION_BOTTOM</literal>,
<literal>PL_POSITION_INSIDE</literal>, and
<literal>PL_POSITION_OUTSIDE</literal> bits specifies one of the 16
- possible standard positions (the 4 corners and 4 side centers for both
- the inside and outside cases) of the legend relative to the adopted
- coordinate system. The adopted coordinates are normalized viewport
- coordinates if the <literal>PL_POSITION_VIEWPORT</literal> bit is set
- or normalized subpage coordinates if the
- <literal>PL_POSITION_SUBPAGE</literal> bit is set. Default position
- bits: If none of <literal>PL_POSITION_LEFT</literal>,
+ possible standard positions (the 4 corners and centers of the 4 sides
+ for both the inside and outside cases) of the legend relative to the
+ adopted coordinate system. The corner positions are specified by the
+ appropriate combination of two of the
+ <literal>PL_POSITION_LEFT</literal>,
<literal>PL_POSITION_RIGHT</literal>,
+ <literal>PL_POSITION_TOP</literal>, and
+ <literal>PL_POSITION_BOTTOM</literal> bits while the sides are
+ specified by a single value of one of those bits. The adopted
+ coordinates are normalized viewport coordinates if the
+ <literal>PL_POSITION_VIEWPORT</literal> bit is set or normalized
+ subpage coordinates if the <literal>PL_POSITION_SUBPAGE</literal> bit
+ is set. Default position bits: If none of
+ <literal>PL_POSITION_LEFT</literal>,
+ <literal>PL_POSITION_RIGHT</literal>,
<literal>PL_POSITION_TOP</literal>, or
<literal>PL_POSITION_BOTTOM</literal> are set, then use the
combination of <literal>PL_POSITION_RIGHT</literal> and
@@ -6493,12 +6980,12 @@
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
- inward/outward from the standard corner positions or standard left or
- right positions if the
+ inward/outward from the standard corner positions or
+ standard left or right positions if the
<literal>PL_POSITION_INSIDE</literal>/<literal>PL_POSITION_OUTSIDE</literal>
bit is set in <literal><parameter>position</parameter></literal>. For
- the standard top or bottom positions, the direction of motion is toward
- positive X.
+ the standard top or bottom positions, the direction of motion is
+ toward positive X.
</para>
</listitem>
</varlistentry>
@@ -6541,7 +7028,7 @@
</term>
<listitem>
<para>
- The cmap0 index of the background color for the legend
+ The cmap0 color of the background for the legend
(<literal>PL_LEGEND_BACKGROUND</literal>).
</para>
</listitem>
@@ -6553,7 +7040,7 @@
</term>
<listitem>
<para>
- The cmap0 index of the color of the bounding-box line for the legend
+ The cmap0 color of the bounding-box line for the legend
(<literal>PL_LEGEND_BOUNDING_BOX</literal>).
</para>
</listitem>
@@ -6565,7 +7052,7 @@
</term>
<listitem>
<para>
- The cmap0 index of the background color for the legend
+ The pllsty style number for the bounding-box line for the legend
(<literal>PL_LEGEND_BACKGROUND</literal>).
</para>
</listitem>
@@ -6696,14 +7183,14 @@
</term>
<listitem>
<para>
- Array of nlegend text colors (cmap0 indices).
+ Array of nlegend cmap0 text colors.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>text</parameter>
- (<literal>const char **</literal>, input)
+ (<literal>const char *const *</literal>, input)
</term>
<listitem>
<para>
@@ -6718,7 +7205,7 @@
</term>
<listitem>
<para>
- Array of nlegend colors (cmap0 indices) for the discrete colored boxes
+ Array of nlegend cmap0 colors for the discrete colored boxes
(<parameter>PL_LEGEND_COLOR_BOX</parameter>).
</para>
</listitem>
@@ -6767,7 +7254,7 @@
</term>
<listitem>
<para>
- Array of nlegend line colors (cmap0 indices)
+ Array of nlegend cmap0 line colors
(<parameter>PL_LEGEND_LINE</parameter>).
</para>
</listitem>
@@ -6803,7 +7290,7 @@
</term>
<listitem>
<para>
- Array of nlegend symbol colors (cmap0 indices)
+ Array of nlegend cmap0 symbol colors
(<parameter>PL_LEGEND_SYMBOL</parameter>).
</para>
</listitem>
@@ -6835,7 +7322,7 @@
<varlistentry>
<term>
<parameter>symbols</parameter>
- (<literal>const char **</literal>, input)
+ (<literal>const char *const *</literal>, input)
</term>
<listitem>
<para>
@@ -6862,7 +7349,7 @@
</para>
<para>
- This function is used in examples 4 and 26.
+ This function is used in examples 4, 26, and 33.
</para>
</sect1>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2013-09-18 07:23:49 UTC (rev 12506)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2013-09-18 07:26:10 UTC (rev 12507)
@@ -92,6 +92,7 @@
<!ENTITY plClearOpts '<link linkend="plClearOpts"><function>plClearOpts</function></link>'>
<!ENTITY plcol0 '<link linkend="plcol0"><function>plcol0</function></link>'>
<!ENTITY plcol1 '<link linkend="plcol1"><function>plcol1</function></link>'>
+<!ENTITY plcolorbar '<link linkend="plcolorbar"><function>plcolorbar</function></link>'>
<!ENTITY plcon0 '<link linkend="plcon0"><function>plcon0</function></link>'>
<!ENTITY plcon1 '<link linkend="plcon1"><function>plcon1</function></link>'>
<!ENTITY plcon2 '<link linkend="plcon2"><function>plcon2</function></link>'>
@@ -149,6 +150,7 @@
<!ENTITY plinit '<link linkend="plinit"><function>plinit</function></link>'>
<!ENTITY pljoin '<link linkend="pljoin"><function>pljoin</function></link>'>
<!ENTITY pllab '<link linkend="pllab"><function>pllab</function></link>'>
+<!ENTITY pllegend '<link linkend="pllegend"><function>pllegend</function></link>'>
<!ENTITY pllightsource '<link linkend="pllightsource"><function>pllightsource</function></link>'>
<!ENTITY plline '<link linkend="plline"><function>plline</function></link>'>
<!ENTITY plline3 '<link linkend="plline3"><function>plline3</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
