cvs: phpdoc /en/functions sesam.xml

hholzgra Mon Nov 12 11:53:52 2001 EDT Modified files: /phpdoc/en/functions sesam.xml Log: please use <parameter><optional> in prototypes only and not in descriptive text (won't work well with DocBook4) Index: phpdoc/en/functions/sesam.xml diff -u phpdoc/en/functions/sesam.xml:1.15 phpdoc/en/functions/sesam.xml:1.16 --- phpdoc/en/functions/sesam.xml:1.15 Mon Nov 12 11:50:43 2001 +++ phpdoc/en/functions/sesam.xml Mon Nov 12 11:53:50 2001 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.15 $ --> +<!-- $Revision: 1.16 $ --> <reference id="ref.sesam"> <title>SESAM database functions</title> <titleabbrev>SESAM</titleabbrev> @@ -1619,7 +1619,7 @@ <function>sesam_query</function> (select type queries only!). </para> <para> - <parameter><optional>whence</optional></parameter> is an optional + <parameter>whence</parameter> is an optional parameter for a fetch operation on "scrollable" cursors, which can be set to the following predefined constants: <table> @@ -1693,17 +1693,17 @@ <para> When using "scrollable" cursors, the cursor can be freely positioned on the result set. If the - <parameter><optional>whence</optional></parameter> parameter is + <parameter>whence</parameter> parameter is omitted, the global default values for the scrolling type (initialized to: <literal>SESAM_SEEK_NEXT</literal>, and settable by <function>sesam_seek_row</function>) are used. If - <parameter><optional>whence</optional></parameter> is supplied, + <parameter>whence</parameter> is supplied, its value replaces the global default. </para> <para> - <parameter><optional>offset</optional></parameter> is an optional + <parameter>offset</parameter> is an optional parameter which is only evaluated (and required) if - <parameter><optional>whence</optional></parameter> is either + <parameter>whence</parameter> is either <literal>SESAM_SEEK_RELATIVE</literal> or <literal>SESAM_SEEK_ABSOLUTE</literal>. This parameter is only valid for "scrollable" cursors. @@ -1796,8 +1796,8 @@ </para> <para> For the valid values of the optional - <parameter><optional>whence</optional></parameter>and - <parameter><optional>offset</optional></parameter> parameters, + <parameter>whence</parameter>and + <parameter>offset</parameter> parameters, see the <function>sesam_fetch_row</function> function for details. </para> @@ -1969,7 +1969,7 @@ </table> </para> <para> - <parameter><optional>offset</optional></parameter> is an optional + <parameter>offset</parameter> is an optional parameter which is only evaluated (and required) if <parameter>whence</parameter> is either <literal>SESAM_SEEK_RELATIVE</literal> or