[Plplot-cvs] SF.net SVN: plplot:[12957] trunk/doc/docbook/src

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

Revision: 12957
          http://sourceforge.net/p/plplot/code/12957
Author:   airwin
Date:     2014-01-24 08:34:51 +0000 (Fri, 24 Jan 2014)
Log Message:
-----------
Implement documentation for plgcmap1_range and plscmap1_range.
Thanks to H?\199?\142ili?\195?\160ng Wang for writing the plplot.h/api.xml
consistency checker that discovered these functions in our
public API did not have any documentation in api.xml.

ToDo: There are still 4 more functions that are missing documentation
according to that checker report and also inconsistencies between
plplot.h and api.xml in the number and names of the function
arguments.

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	2014-01-24 05:11:55 UTC (rev 12956)
+++ trunk/doc/docbook/src/api.xml	2014-01-24 08:34:51 UTC (rev 12957)
@@ -4559,6 +4559,64 @@
 
   </sect1>
 
+  <sect1 id="plgcmap1_range" renderas="sect3">
+    <title>
+      <function>plgcmap1_range</function>: Get the cmap1 argument
+      range for continuous color plots
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plgcmap1_range</function>
+	  </funcdef>
+	  <paramdef><parameter>min_color</parameter></paramdef>
+	  <paramdef><parameter>max_color</parameter></paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+      Get the cmap1 argument range for continuous color plots.
+      (Use &plscmap1_range; to set the cmap1 argument range.)
+    </para>
+
+    <variablelist>
+      <varlistentry>
+	<term>
+	  <parameter>min_color</parameter>
+	  (<literal>PLFLT *</literal>, output)
+	</term>
+	<listitem>
+	  <para>
+	    Pointer to the current minimum cmap1 floating point argument.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>max_color</parameter>
+	  (<literal>PLFLT *</literal>, output)
+	</term>
+	<listitem>
+	  <para>
+	    Pointer to the current maximum cmap1 floating point argument.
+	  </para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>
+      Redacted form: <function>plgcmap1_range(min_color, max_color)</function>
+    </para>
+
+    <para>
+      This function is currently not used in any example.
+    </para>
+
+  </sect1>
+
   <sect1 id="plgcol0" renderas="sect3">
     <title>
       <function>plgcol0</function>: Returns 8-bit RGB values for given color
@@ -11157,6 +11215,69 @@
 
   </sect1>
 
+  <sect1 id="plscmap1_range" renderas="sect3">
+    <title>
+      <function>plscmap1_range</function>: Set the cmap1 argument
+      range for continuous color plots
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plscmap1_range</function>
+	  </funcdef>
+	  <paramdef><parameter>min_color</parameter></paramdef>
+	  <paramdef><parameter>max_color</parameter></paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+      Set the cmap1 argument range for continuous color
+      plots. If <parameter>min_color</parameter> is greater than
+      <parameter>max_color</parameter> or
+      <parameter>max_color</parameter> is greater than 1.0 or
+      <parameter>min_color</parameter> is less than 0.0 then no change
+      is made.  (Use &plgcmap1_range; to get the cmap1
+      argument range.)
+    </para>
+
+    <variablelist>
+      <varlistentry>
+	<term>
+	  <parameter>min_color</parameter>
+	  (<literal>PLFLT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    The minimum cmap1 floating point argument.
+	  </para>
+	</listitem>
+      </varlistentry>
+      <varlistentry>
+	<term>
+	  <parameter>max_color</parameter>
+	  (<literal>PLFLT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    The maximum cmap1 floating point argument.
+	  </para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>
+      Redacted form: <function>plscmap1_range(min_color, max_color)</function>
+    </para>
+
+    <para>
+      This function is currently used in example 33.
+    </para>
+
+  </sect1>
+
   <sect1 id="plscmap1" renderas="sect3">
     <title>
       <function>plscmap1</function>: Set color map1 colors using 8-bit RGB

Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in	2014-01-24 05:11:55 UTC (rev 12956)
+++ trunk/doc/docbook/src/plplotdoc.xml.in	2014-01-24 08:34:51 UTC (rev 12957)
@@ -116,6 +116,7 @@
 <!ENTITY plfontld '<link linkend="plfontld"><function>plfontld</function></link>'>
 <!ENTITY plFree2dGrid '<link linkend="plFree2dGrid"><function>plFree2dGrid</function></link>'>
 <!ENTITY plgch '<link linkend="plgch"><function>plgch</function></link>'>
+<!ENTITY plgcmap1_range '<link linkend="plgcmap1_range"><function>plgcmap1_range</function></link>'>
 <!ENTITY plgcol0 '<link linkend="plgcol0"><function>plgcol0</function></link>'>
 <!ENTITY plgcolbg '<link linkend="plgcolbg"><function>plgcolbg</function></link>'>
 <!ENTITY plgcompression '<link linkend="plgcompression"><function>plgcompression</function></link>'>
@@ -182,6 +183,7 @@
 <!ENTITY plschr '<link linkend="plschr"><function>plschr</function></link>'>
 <!ENTITY plscmap0 '<link linkend="plscmap0"><function>plscmap0</function></link>'>
 <!ENTITY plscmap0n '<link linkend="plscmap0n"><function>plscmap0n</function></link>'>
+<!ENTITY plscmap1_range '<link linkend="plscmap1_range"><function>plgsmap1_range</function></link>'>
 <!ENTITY plscmap1 '<link linkend="plscmap1"><function>plscmap1</function></link>'>
 <!ENTITY plscmap1l '<link linkend="plscmap1l"><function>plscmap1l</function></link>'>
 <!ENTITY plscmap1n '<link linkend="plscmap1n"><function>plscmap1n</function></link>'>

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