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

[<hba...@us...>]

Revision: 10143
          http://plplot.svn.sourceforge.net/plplot/?rev=10143&view=rev
Author:   hbabcock
Date:     2009-07-12 23:00:11 +0000 (Sun, 12 Jul 2009)

Log Message:
-----------
Add documentation for plspal0 and plspal1 functions.

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

Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml	2009-07-12 19:30:47 UTC (rev 10142)
+++ trunk/doc/docbook/src/api.xml	2009-07-12 23:00:11 UTC (rev 10143)
@@ -7,7 +7,7 @@
 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004  Rafael Laboissiere
 Copyright (C) 2003  Joao Cardoso
 Copyright (C) 2004, 2007  Andrew Ross
-Copyright (C) 2007  Hazen Babcock
+Copyright (C) 2007, 2009  Hazen Babcock
 
 Redistribution and use in source (XML DocBook) and "compiled" forms
 (HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
@@ -12125,6 +12125,7 @@
 
   </sect1>
 
+
   <sect1 id="plspage" renderas="sect3">
     <title>
       <function>plspage</function>: Set page parameters
@@ -12238,6 +12239,105 @@
 
   </sect1>
 
+  <sect1 id="plspal0" renderas="sect3">
+    <title>
+      <function>plspal0</function>: Set PLplot color table 0 using a PLplot cmap0 palette file.
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plspal0</function>
+	  </funcdef>
+	  <paramdef><parameter>filename</parameter></paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+      Sets color table 0 using the PLplot palette file specified by
+      filename. Example palette files for color table 0 can be found
+      in the installed PLplot directory. Note also that you don't need
+      to include the path in the filename if the file is located in the
+      directories that are searched by default by PLplot.
+    </para>
+
+    <variablelist>
+      <varlistentry>
+	<term>
+	  <parameter>filename</parameter>
+	  (<literal>const char *</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    A string containing the filename of the desired color table 0
+	    palette file.
+	  </para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>
+      Redacted form: <function>plspal0(filename)</function>
+    </para>
+
+    <para>
+      This function is used in example 16.
+    </para>
+
+  </sect1>
+
+
+  <sect1 id="plspal1" renderas="sect3">
+    <title>
+      <function>plspal1</function>: Set PLplot color table 1 using a PLplot cmap1 palette file.
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plspal1</function>
+	  </funcdef>
+	  <paramdef><parameter>filename</parameter></paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+      Sets color table 1 using the PLplot palette file specified by
+      filename. Example palette files for color table 1 can be found
+      in the installed PLplot directory. Note also that you don't need
+      to include the path in the filename if the file is located in the
+      directories that are searched by default by PLplot.
+    </para>
+
+    <variablelist>
+      <varlistentry>
+	<term>
+	  <parameter>filename</parameter>
+	  (<literal>const char *</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    A string containing the filename of the desired color table 1
+	    palette file.
+	  </para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>
+      Redacted form: <function>plspal1(filename)</function>
+    </para>
+
+    <para>
+      This function is used in example 16.
+    </para>
+
+  </sect1>
+
   <sect1 id="plspause" renderas="sect3">
     <title>
       <function>plspause</function>: Set the pause (on end-of-page) status


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