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

[<and...@us...>]

Revision: 8994
          http://plplot.svn.sourceforge.net/plplot/?rev=8994&view=rev
Author:   andrewross
Date:     2008-11-19 12:08:49 +0000 (Wed, 19 Nov 2008)

Log Message:
-----------
Further documentation tweaks for C functions not in the API.

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

Modified: trunk/doc/docbook/src/api-c.xml
===================================================================
--- trunk/doc/docbook/src/api-c.xml	2008-11-19 11:02:32 UTC (rev 8993)
+++ trunk/doc/docbook/src/api-c.xml	2008-11-19 12:08:49 UTC (rev 8994)
@@ -201,8 +201,10 @@
     
     <para>
     Allocates a block of memory for use as a 2-d grid of type
-    PLFLT. The grid is vectored 2d C style grid and so can be accessed
-    using syntax like <literal>f[i][j]</literal>.
+    PLFLT. The grid is a vectored 2-d C-style array and so can be accessed
+    using syntax like <literal>*f[i][j]</literal>. The memory associated
+    with the grid must be freed by 
+    calling &plFree2dGrid; once it is no longer required.
     </para>
 
     <variablelist>
@@ -232,9 +234,9 @@
 	</listitem>
       </varlistentry>
     </variablelist>
-
+    
   </sect1>
-
+  
   <sect1 id="plexit" renderas="sect3">
     <title>
       <function>plexit</function>: Error exit
@@ -276,13 +278,13 @@
     </variablelist>
 
   </sect1>
-
+  
   <sect1 id="plFree2dGrid" renderas="sect3">
     <title>
-      <function>plFree2dGrid</function>: Free the memory associated
-    with a 2-d grid allocated using &plAlloc2dGrid. 
+        <function>plFree2dGrid</function>: Free the memory associated
+	with a 2-d grid allocated using &plAlloc2dGrid;.
     </title>
-
+    
     <para>
       <funcsynopsis>
 	<funcprototype>
@@ -297,7 +299,7 @@
     </para>
     
     <para>
-    Frees a block of memory allocated using &plAlloc2dGrid.
+    Frees a block of memory allocated using &plAlloc2dGrid;.
     </para>
 
     <variablelist>
@@ -366,7 +368,7 @@
   <sect1 id="plMinMax2dGrid" renderas="sect3">
     <title>
       <function>plMinMax2dGrid</function>: Find the minimum and
-    maximum of a 2d grid allocated using &plAlloc2dGrid.
+    maximum of a 2d grid allocated using &plAlloc2dGrid;.
     </title>
 
     <para>
@@ -385,7 +387,7 @@
     </para>
     
     <para>
-    Find the minimum and maximum of a 2d grid allocated using &plAlloc2dGrid.
+    Find the minimum and maximum of a 2d grid allocated using &plAlloc2dGrid;.
     </para>
 
     <variablelist>

Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in	2008-11-19 11:02:32 UTC (rev 8993)
+++ trunk/doc/docbook/src/plplotdoc.xml.in	2008-11-19 12:08:49 UTC (rev 8994)
@@ -76,6 +76,7 @@
 <!ENTITY pl_setcontlabelparam '<link linkend="pl_setcontlabelparam"><function>pl_setcontlabelparam</function></link>'>
 <!ENTITY plabort '<link linkend="plabort"><function>plabort</function></link>'>
 <!ENTITY pladv '<link linkend="pladv"><function>pladv</function></link>'>
+<!ENTITY plAlloc2dGrid '<link linkend="plAlloc2dGrid"><function>plAlloc2dGrid</function></link>'>
 <!ENTITY plaxes '<link linkend="plaxes"><function>plaxes</function></link>'>
 <!ENTITY plbin '<link linkend="plbin"><function>plbin</function></link>'>
 <!ENTITY plbop '<link linkend="plbop"><function>plbop</function></link>'>
@@ -107,6 +108,7 @@
 <!ENTITY plflush '<link linkend="plflush"><function>plflush</function></link>'>
 <!ENTITY plfont '<link linkend="plfont"><function>plfont</function></link>'>
 <!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 plgcol0 '<link linkend="plgcol0"><function>plgcol0</function></link>'>
 <!ENTITY plgcolbg '<link linkend="plgcolbg"><function>plgcolbg</function></link>'>


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