Menu
▾
▴
[Plplot-cvs] plplot/doc/docbook/src api.xml,1.81,1.82
|
From: Alan W. I. <ai...@us...> - 2006-05-17 22:28:04
|
Update of /cvsroot/plplot/plplot/doc/docbook/src In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv28126 Modified Files: api.xml Log Message: Update logical (PLBOOL) argument documentation for plshade, plshade1, plshades, plspause, plstripc, and plxormod. Index: api.xml =================================================================== RCS file: /cvsroot/plplot/plplot/doc/docbook/src/api.xml,v retrieving revision 1.81 retrieving revision 1.82 diff -u -d -r1.81 -r1.82 --- api.xml 13 May 2006 07:15:45 -0000 1.81 +++ api.xml 17 May 2006 22:27:54 -0000 1.82 @@ -5712,7 +5712,7 @@ <listitem> <para> Flag to indicate whether or not ``sides'' should be draw on the - figure. If <literal><parameter>side</parameter>=true</literal> + figure. If <literal><parameter>side</parameter></literal> is true sides are drawn, otherwise no sides are drawn. </para> </listitem> @@ -8179,20 +8179,21 @@ <varlistentry> <term> <parameter>rectangular</parameter> - (<literal>PLINT</literal>, input) + (<literal>PLBOOL</literal>, input) </term> <listitem> <para> - Set <literal><parameter>rectangular</parameter></literal> to 1 + Set <literal><parameter>rectangular</parameter></literal> to true if rectangles map to rectangles after coordinate transformation with <literal><parameter>pltrl</parameter></literal>. Otherwise, - set <literal><parameter>rectangular</parameter></literal> to 0. + set <literal><parameter>rectangular</parameter></literal> to false. If <literal><parameter>rectangular</parameter></literal> - is set to 1, plshade tries to save time by + is set to true, plshade tries to save time by filling large rectangles. This optimization fails if the coordinate transformation distorts the shape of rectangles. - For example a plot in polor coordinates has to have rectangular - set to 0. + For example a plot in polor coordinates has to have + <literal><parameter>rectangular</parameter></literal> + set to false. </para> </listitem> </varlistentry> @@ -8464,7 +8465,7 @@ <varlistentry> <term> <parameter>rectangular</parameter> - (<literal>PLINT</literal>, input) + (<literal>PLBOOL</literal>, input) </term> <listitem> <para> @@ -8780,20 +8781,21 @@ <varlistentry> <term> <parameter>rectangular</parameter> - (<literal>PLINT</literal>, input) + (<literal>PLBOOL</literal>, input) </term> <listitem> <para> - Set <literal><parameter>rectangular</parameter></literal> to 1 + Set <literal><parameter>rectangular</parameter></literal> to true if rectangles map to rectangles after coordinate transformation with <literal><parameter>pltrl</parameter></literal>. Otherwise, - set <literal><parameter>rectangular</parameter></literal> to 0. + set <literal><parameter>rectangular</parameter></literal> to false. If <literal><parameter>rectangular</parameter></literal> - is set to 1, plshade tries to save time by + is set to true, plshade tries to save time by filling large rectangles. This optimization fails if the coordinate transformation distorts the shape of rectangles. - For example a plot in polor coordinates has to have rectangular - set to 0. + For example a plot in polor coordinates has to have + <literal><parameter>rectangular</parameter></literal> + set to false. </para> </listitem> </varlistentry> @@ -9177,11 +9179,11 @@ <varlistentry> <term> <parameter>pause</parameter> - (<literal>PLINT</literal>, input) + (<literal>PLBOOL</literal>, input) </term> <listitem> <para> - If <literal><parameter>pause</parameter></literal> = 1 there + If <literal><parameter>pause</parameter></literal> is true there will be a pause on end-of-page for those drivers which support this. Otherwise there is no pause. </para> @@ -9697,22 +9699,26 @@ <varlistentry> <term> <parameter>y_ascl</parameter> - (<literal>PLINT</literal>, input) + (<literal>PLBOOL</literal>, input) </term> <listitem> <para> - Autoscale y between x jumps (1) or not (0). + Autoscale y between x jumps if + <literal><parameter>y_ascl</parameter></literal> is true, + otherwise not. </para> </listitem> </varlistentry> <varlistentry> <term> <parameter>acc</parameter> - (<literal>PLINT</literal>, input) + (<literal>PLBOOL</literal>, input) </term> <listitem> <para> - Accumulate strip plot (1) or slide (0). + Accumulate strip plot if + <literal><parameter>acc</parameter></literal> is true, + otherwise slide display. </para> </listitem> </varlistentry> @@ -11197,34 +11203,40 @@ </para> <para> - Enter (mode !=0) or leave (mode == 0) xor mode for those drivers + Enter (when <literal><parameter>mode</parameter></literal> is true) + or leave (when <literal><parameter>mode</parameter></literal> is false) + xor mode for those drivers (e.g., the xwin driver) that support it. Enables erasing plots by drawing twice the same line, symbol, etc. If driver is not capable - of xor operation returns status of 0. + of xor operation it returns a + <literal><parameter>status</parameter></literal> of false. </para> <variablelist> <varlistentry> <term> <parameter>mode</parameter> - (<literal>PLINT</literal>, input) + (<literal>PLBOOL</literal>, input) </term> <listitem> <para> - mode != 0 means enter xor mode and mode == 0 means leave xor - mode. + <literal><parameter>mode</parameter></literal> is true + means enter xor mode and + <literal><parameter>mode</parameter></literal> is false + means leave xor mode. </para> </listitem> </varlistentry> <varlistentry> <term> <parameter>status</parameter> - (<literal>PLINT *</literal>, output) + (<literal>PLBOOL *</literal>, output) </term> <listitem> <para> - Pointer to status. Returned status == 1 (0) means driver is capable - (incapable) of xor mode. + Pointer to status. Returned + <literal><parameter>mode</parameter></literal>status of true (false) + means driver is capable (incapable) of xor mode. </para> </listitem> </varlistentry> |