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

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

Revision: 11679
          http://plplot.svn.sourceforge.net/plplot/?rev=11679&view=rev
Author:   airwin
Date:     2011-03-27 17:32:42 +0000 (Sun, 27 Mar 2011)

Log Message:
-----------
Clarify documentation of sh_cmap argument for plshade1. 

Modified Paths:
--------------
    trunk/doc/docbook/src/api.xml

Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml	2011-03-24 19:13:36 UTC (rev 11678)
+++ trunk/doc/docbook/src/api.xml	2011-03-27 17:32:42 UTC (rev 11679)
@@ -12670,7 +12670,14 @@
 	</term>
 	<listitem>
 	  <para>
-	    Defines color map.
+	    Defines color map. If 
+	    <literal><parameter>sh_cmap</parameter>=0</literal>, then
+	    <literal><parameter>sh_color</parameter></literal>
+	    is interpreted as a color map 0 (integer) index.  If 
+	    <literal><parameter>sh_cmap</parameter>=1</literal>, then
+	    <literal><parameter>sh_color</parameter></literal>
+	    is interpreted as a color map 1 floating-point index which
+	    ranges from 0. to 1.
 	  </para>
 	</listitem>
       </varlistentry>


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