Menu
▾
▴
[Plplot-cvs] SF.net SVN: plplot:[9016] trunk/doc/docbook/src
|
From: <and...@us...> - 2008-11-24 16:43:38
|
Revision: 9016
http://plplot.svn.sourceforge.net/plplot/?rev=9016&view=rev
Author: andrewross
Date: 2008-11-24 16:43:30 +0000 (Mon, 24 Nov 2008)
Log Message:
-----------
Update documentation to include plGetCursor and to indicate which
examples the non common API functions appear in.
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-24 16:13:13 UTC (rev 9015)
+++ trunk/doc/docbook/src/api-c.xml 2008-11-24 16:43:30 UTC (rev 9016)
@@ -6,6 +6,7 @@
Copyright (C) 1999, 2000, 2001, 2002, 2003 Alan W. Irwin
Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004 Rafael Laboissiere
Copyright (C) 2003 Joao Cardoso
+Copyright (C) 2008 Andrew Ross
Redistribution and use in source (XML DocBook) and "compiled" forms
(HTML, PDF, PostScript, DVI, TeXinfo and so forth) with or without
@@ -52,6 +53,14 @@
is whatever C-explicit code we are trying to understand at the time.
</para>
+ <para>
+ The functions currently documented here are either C specific utility
+ functions (e.g. &plAlloc2dGrid;, &plFree2dGrid;) or internal functions
+ which might of use to developers (e.g. &plP_checkdriverinit;). Some of
+ the utility functions are also implemented in some other languages (e.g.
+ &plGetCursor;).
+ </para>
+
<sect1 id="plP_checkdriverinit" renderas="sect3">
<title>
<function>plP_checkdriverinit</function>: Checks to see if any
@@ -97,6 +106,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plP_getinitdriverlist" renderas="sect3">
@@ -138,6 +151,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plabort" renderas="sect3">
@@ -178,6 +195,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in example 20.
+ </para>
+
</sect1>
<sect1 id="plAlloc2dGrid" renderas="sect3">
@@ -234,6 +255,10 @@
</listitem>
</varlistentry>
</variablelist>
+
+ <para>
+ This function is used in examples 8, 9, 11, 14, 16, 20, 21, 22, 28, 30.
+ </para>
</sect1>
@@ -277,6 +302,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plFree2dGrid" renderas="sect3">
@@ -327,8 +356,57 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in examples 8, 9, 11, 14, 16, 20, 21, 22, 28, 30.
+ </para>
+
</sect1>
+
+
+ <sect1 id="plGetCursor" renderas="sect3">
+ <title>
+ <function>plGetCursor</function>: Wait for graphics input event and translate to world coordinates.
+ </title>
+
+ <para>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>
+ <function>plGetCursor</function>
+ </funcdef>
+ <paramdef><parameter>gin</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </para>
+
+ <para>
+ Wait for graphics input event and translate to world coordinates.
+ Returns 0 if no translation to world coordinates is possible.
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>gin</parameter>
+ (<literal>PLGraphicsIn *</literal>, output)
+ </term>
+ <listitem>
+ <para>
+ Pointer to PLGraphicsIn structure which will contain the
+ output. The structure is not allocated by the routine
+ and must exist before the function is called.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ This function is used in examples 1 and 20.
+ </para>
+
+ </sect1>
+
<sect1 id="plgfile" renderas="sect3">
<title>
<function>plgfile</function>: Get output file handle
@@ -363,6 +441,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plMinMax2dGrid" renderas="sect3">
@@ -427,6 +509,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in examples 8, 11, 20 and 21.
+ </para>
+
</sect1>
<sect1 id="plsabort" renderas="sect3">
@@ -463,6 +549,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plsexit" renderas="sect3">
@@ -499,6 +589,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="plsfile" renderas="sect3">
@@ -541,6 +635,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="pltr0" renderas="sect3">
@@ -631,6 +729,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is not used in any examples.
+ </para>
+
</sect1>
<sect1 id="pltr1" renderas="sect3">
@@ -722,6 +824,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in examples 9 and 16.
+ </para>
+
</sect1>
<sect1 id="pltr2" renderas="sect3">
@@ -814,6 +920,10 @@
</varlistentry>
</variablelist>
+ <para>
+ This function is used in example 22.
+ </para>
+
</sect1>
</chapter>
Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in 2008-11-24 16:13:13 UTC (rev 9015)
+++ trunk/doc/docbook/src/plplotdoc.xml.in 2008-11-24 16:43:30 UTC (rev 9016)
@@ -117,6 +117,7 @@
<!ENTITY plgdidev '<link linkend="plgdidev"><function>plgdidev</function></link>'>
<!ENTITY plgdiori '<link linkend="plgdiori"><function>plgdiori</function></link>'>
<!ENTITY plgdiplt '<link linkend="plgdiplt"><function>plgdiplt</function></link>'>
+<!ENTITY plGetCursor '<link linkend="plGetCursor"><function>plGetCursor</function></link>'>
<!ENTITY plgfam '<link linkend="plgfam"><function>plgfam</function></link>'>
<!ENTITY plgfci '<link linkend="plgfci"><function>plgfci</function></link>'>
<!ENTITY plgfnam '<link linkend="plgfnam"><function>plgfnam</function></link>'>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
