Menu
▾
▴
[Plplot-cvs] SF.net SVN: plplot:[11678] trunk
|
From: <ai...@us...> - 2011-03-24 19:13:42
|
Revision: 11678
http://plplot.svn.sourceforge.net/plplot/?rev=11678&view=rev
Author: airwin
Date: 2011-03-24 19:13:36 +0000 (Thu, 24 Mar 2011)
Log Message:
-----------
Update (or implement in the case of plstring3 and docbook) doxygen and
docbook documentation for plpoin, plpoin3, plsym, plstring, and
plstring3.
Modified Paths:
--------------
trunk/doc/docbook/src/api.xml
trunk/doc/docbook/src/plplotdoc.xml.in
trunk/src/plsym.c
Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml 2011-03-23 21:34:29 UTC (rev 11677)
+++ trunk/doc/docbook/src/api.xml 2011-03-24 19:13:36 UTC (rev 11678)
@@ -6451,6 +6451,7 @@
<literal><parameter>nrow</parameter></literal> > 1 and
<literal><parameter>ncolumn</parameter></literal> > 1, then plot
the resulting array of legend entries in row-major order.
+ Otherwise, plot the legend entries in column-major order.
</para>
</listitem>
</varlistentry>
@@ -8717,13 +8718,10 @@
</para>
<para>
- Plot a glyph at a set of
- <literal><parameter>n</parameter></literal> points at positions
- <literal>(<parameter>x</parameter>[i],
- <parameter>y</parameter>[i])</literal> using the glyph defined by
- <literal><parameter>code</parameter></literal>. This function is
- superseded by &plstring; which gives access to many(!) more glyphs.
- code=-1 means try to just draw a point. Right now it's just a move
+ Plot a glyph at the specified points. (This function is largely
+ superseded by &plstring; which gives access to many[!] more glyphs.)
+ <literal><parameter>code</parameter>=-1</literal> means try to
+ just draw a point. Right now it's just a move
and a draw at the same place. Not ideal, since a sufficiently
intelligent output device may optimize it away, or there may be faster
ways of doing it. This is OK for now, though, and offers a 4X speedup
@@ -8777,8 +8775,9 @@
</term>
<listitem>
<para>
- Hershey symbol code corresponding to a glyph to be plotted
- at each of the <literal><parameter>n</parameter></literal> points.
+ Hershey symbol code (in "ascii-indexed" form with -1 <= code <=
+ 127) corresponding to a glyph to be plotted at each of the
+ <literal><parameter>n</parameter></literal> points.
</para>
</listitem>
</varlistentry>
@@ -8789,7 +8788,7 @@
</para>
<para>
- This function is used in examples 1,6,14,18,21,29.
+ This function is used in examples 1,6,14,21,29.
</para>
</sect1>
@@ -8815,11 +8814,10 @@
</para>
<para>
- Plot a glyph at a set of
- <literal><parameter>n</parameter></literal> points at positions
- <literal>(<parameter>x</parameter>[i], <parameter>y</parameter>[i],
- <parameter>z</parameter>[i])</literal> using the glyph defined by
- <literal><parameter>code</parameter></literal>. code=-1 means try to
+ Plot a glyph at the specified 3D points. (This function is largely
+ superseded by &plstring3; which gives access to many[!] more glyphs.)
+ Set up the call to this function similar to what is done for &plline3;.
+ <literal><parameter>code</parameter>=-1</literal> means try to
just draw a point. Right now it's just a move and a draw at the same
place. Not ideal, since a sufficiently intelligent output device may
optimize it away, or there may be faster ways of doing it. This is OK
@@ -8897,7 +8895,7 @@
</para>
<para>
- This function is used in example 18.
+ This function is not used in any example.
</para>
</sect1>
@@ -13936,16 +13934,15 @@
</para>
<para>
- Plot glyphs (normally just one of them) at a set of
- <literal><parameter>n</parameter></literal> points at positions
- <literal>(<parameter>x</parameter>[i],
- <parameter>y</parameter>[i])</literal> using the glyph defined by
- <literal><parameter>string</parameter></literal>. Supersedes &plpoin;
- and &plsym; because many(!) more glyphs are accessible with
- &plstring;. The glyph is specified with a PLplot user string. As
- with &plmtex; and &plptex;, the user string can contain FCI escapes to
- determine the font, UTF-8 code to determine the glyph or else PLplot
- escapes for Hershey or unicode text to determine the glyph.
+ Plot a glyph at the specified points. (Supersedes &plpoin; and
+ &plsym; because many[!] more glyphs are accessible with &plstring;.)
+ The glyph is specified with a PLplot user string. Note that the user
+ string is not actually limited to one glyph so it is possible (but not
+ normally useful) to plot more than one glyph at the specified points
+ with this function. As with &plmtex; and &plptex;, the user string
+ can contain FCI escapes to determine the font, UTF-8 code to determine
+ the glyph or else PLplot escapes for Hershey or unicode text to
+ determine the glyph.
</para>
<variablelist>
@@ -14000,15 +13997,121 @@
</variablelist>
<para>
- Redacted form: <function>plsym(x, y, code)</function>
+ Redacted form: <function>plstring(x, y, string)</function>
</para>
<para>
- This function is used in example 7.
+ This function is used in examples 4 and 26.
</para>
</sect1>
+ <sect1 id="plstring3" renderas="sect3">
+ <title>
+ <function>plstring3</function>: Plot a glyph at the specified 3D points
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plstring3</function>
+ </funcdef>
+ <paramdef><parameter>n</parameter></paramdef>
+ <paramdef><parameter>x</parameter></paramdef>
+ <paramdef><parameter>y</parameter></paramdef>
+ <paramdef><parameter>z</parameter></paramdef>
+ <paramdef><parameter>string</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Plot a glyph at the specified 3D points. (Supersedes &plpoin3;
+ because many[!] more glyphs are accessible with &plstring3;.)
+ Set up the call to this function similar to what is done for &plline3;.
+ The glyph is specified with a PLplot user string. Note that the user
+ string is not actually limited to one glyph so it is possible (but not
+ normally useful) to plot more than one glyph at the specified points
+ with this function. As with &plmtex; and &plptex;, the user string
+ can contain FCI escapes to determine the font, UTF-8 code to determine
+ the glyph or else PLplot escapes for Hershey or unicode text to
+ determine the glyph.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>n</parameter>
+ (<literal>PLINT</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Number of points in the
+ <literal><parameter>x</parameter></literal>,
+ <literal><parameter>y</parameter></literal>, and
+ <literal><parameter>z</parameter></literal> arrays.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>x</parameter>
+ (<literal>PLFLT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Pointer to an array with X coordinates of points.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>y</parameter>
+ (<literal>PLFLT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Pointer to an array with Y coordinates of points.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>z</parameter>
+ (<literal>PLFLT *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ Pointer to an array with Z coordinates of points.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>string</parameter>
+ (<literal>const char *</literal>, input)
+ </term>
+ <listitem>
+ <para>
+ PLplot user string corresponding to the glyph to be
+ plotted at each of the <literal><parameter>n</parameter></literal>
+ points.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Redacted form: <function>plstring3(x, y, z, string)</function>
+ </para>
+
+ <para>
+ This function is used in example 18.
+ </para>
+
+ </sect1>
+
<sect1 id="plstripa" renderas="sect3">
<title>
<function>plstripa</function>: Add a point to a stripchart
@@ -15223,13 +15326,9 @@
</para>
<para>
- Plot a glyph at a set of
- <literal><parameter>n</parameter></literal> points at positions
- <literal>(<parameter>x</parameter>[i],
- <parameter>y</parameter>[i])</literal> using the glyph defined by
- <literal><parameter>code</parameter></literal>. The code is
- interpreted as an index in the Hershey font tables. This function is
- superseded by &plstring; which gives access to many(!) more glyphs.
+ Plot a glyph at the specified points. (This function is
+ largely superseded by &plstring; which gives access to many[!]
+ more glyphs.)
</para>
<variablelist>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2011-03-23 21:34:29 UTC (rev 11677)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2011-03-24 19:13:36 UTC (rev 11678)
@@ -225,6 +225,7 @@
<!ENTITY plstar '<link linkend="plstar"><function>plstar</function></link>'>
<!ENTITY plstripa '<link linkend="plstripa"><function>plstripa</function></link>'>
<!ENTITY plstring '<link linkend="plstring"><function>plstring</function></link>'>
+<!ENTITY plstring3 '<link linkend="plstring3"><function>plstring3</function></link>'>
<!ENTITY plstripc '<link linkend="plstripc"><function>plstripc</function></link>'>
<!ENTITY plstripd '<link linkend="plstripd"><function>plstripd</function></link>'>
<!ENTITY plstart '<link linkend="plstart"><function>plstart</function></link>'>
Modified: trunk/src/plsym.c
===================================================================
--- trunk/src/plsym.c 2011-03-23 21:34:29 UTC (rev 11677)
+++ trunk/src/plsym.c 2011-03-24 19:13:36 UTC (rev 11678)
@@ -83,13 +83,15 @@
plhrsh2( PLINT ch, PLINT x, PLINT y );
//--------------------------------------------------------------------------
-//! Plot glyphs (normally just one of them) at the specified
-//! coordinates. This function largely supersedes plpoin and plsym
-//! because many(!) more glyphs are accessible with plstring. The
-//! glyph is specified with a PLplot user string. As with plmtex and
-//! plptex, the user string can contain FCI escapes to determine the
-//! font, UTF-8 code to determine the glyph or else PLplot escapes for
-//! Hershey or unicode text to determine the glyph.
+//! Plot a glyph at the specified points. (This function largely
+//! supersedes plpoin and plsym because many[!] more glyphs are
+//! accessible with plstring.) The glyph is specified with a PLplot
+//! user string. Note that the user string is not actually limited to
+//! one glyph so it is possible (but not normally useful) to plot more
+//! than one glyph at the specified points with this function. As
+//! with plmtex and plptex, the user string can contain FCI escapes to
+//! determine the font, UTF-8 code to determine the glyph or else
+//! PLplot escapes for Hershey or unicode text to determine the glyph.
//! @param n Number of points in x and y arrays.
//! @param x Array of X coordinates of points.
//! @param y Array of Y coordinates of points.
@@ -108,8 +110,8 @@
}
//--------------------------------------------------------------------------
-//! Plot a glyph at the specified points. This function is largely
-//! superseded by plstring which gives access to many(!) more glyphs.
+//! Plot a glyph at the specified points. (This function is largely
+//! superseded by plstring which gives access to many[!] more glyphs.)
//! @param n Number of points in x and y arrays.
//! @param x Pointer to an array with X coordinates of points.
//! @param y Pointer to an array with Y coordinates of points.
@@ -142,8 +144,8 @@
}
//--------------------------------------------------------------------------
-//! Plot a glyph at the specified points. This function is largely
-//! superseded by plstring which gives access to many(!) more glyphs.
+//! Plot a glyph at the specified points. (This function is largely
+//! superseded by plstring which gives access to many[!] more glyphs.)
//! code=-1 means try to just draw a point. Right now it's just a
//! move and a draw at the same place. Not ideal, since a
//! sufficiently intelligent output device may optimize it away, or
@@ -203,11 +205,11 @@
}
//--------------------------------------------------------------------------
-//! Plot a glyph at the specified 3D points. Setup the call to this
-//! function similar to what is done for plline3. This function is
-//! largely superseded by plstring3 which gives access to many(!) more
-//! glyphs. code=-1 means try to just draw a point. Right now it's
-//! just a move and a draw at the same place. Not ideal, since a
+//! Plot a glyph at the specified 3D points. (This function is
+//! largely superseded by plstring3 which gives access to many[!] more
+//! glyphs.) Set up the call to this function similar to what is done
+//! for plline3. code=-1 means try to just draw a point. Right now
+//! it's just a move and a draw at the same place. Not ideal, since a
//! sufficiently intelligent output device may optimize it away, or
//! there may be faster ways of doing it. This is OK for now, though,
//! and offers a 4X speedup over drawing a Hershey font "point" (which
@@ -281,14 +283,17 @@
}
//--------------------------------------------------------------------------
-//! Plot glyphs (normally just one of them) at the specified 3D
-//! coordinates. Setup the call to this function similar to what is
-//! done for plline3. This function largely supersedes plpoin3
-//! because many(!) more glyphs are accessible with plstring3. The
-//! glyph is specified with a PLplot user string. As with plmtex and
-//! plptex, the user string can contain FCI escapes to determine the
-//! font, UTF-8 code to determine the glyph or else PLplot escapes for
-//! Hershey or unicode text to determine the glyph.
+//! Plot a glyph at the specified 3D points. (This function
+//! largely supersedes plpoin3 because many[!] more glyphs are
+//! accessible with plstring3). Set up the call to this function
+//! similar to what is done for plline3. The glyph is specified with
+//! a PLplot user string. Note that the user string is not actually
+//! limited to one glyph so it is possible (but not normally useful)
+//! to plot more than one glyph at the specified points with this
+//! function. As with plmtex and plptex, the user string can contain
+//! FCI escapes to determine the font, UTF-8 code to determine the
+//! glyph or else PLplot escapes for Hershey or unicode text to
+//! determine the glyph.
//! @param n Number of points in x, y, and z arrays.
//! @param x Array of X coordinates of points.
//! @param y Array of Y coordinates of points.
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
