cvs: phpdoc /en/reference/filepro/functions filepro-fieldcount.xml filepro-fieldname.xml filepro-fieldtype.xml filepro-fieldwidth.xml
filepro-retrieve.xml filepro-rowcount.xml filepro.xml

didou Mon Jan 8 00:47:19 2007 UTC Modified files: /phpdoc/en/reference/filepro/functions filepro-fieldcount.xml filepro-fieldname.xml filepro-fieldtype.xml filepro-fieldwidth.xml filepro-retrieve.xml filepro-rowcount.xml filepro.xml Log: Switch to new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filepro/functions/filepro-fieldcount.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/filepro/functions/filepro-fieldcount.xml diff -u phpdoc/en/reference/filepro/functions/filepro-fieldcount.xml:1.3 phpdoc/en/reference/filepro/functions/filepro-fieldcount.xml:1.4 --- phpdoc/en/reference/filepro/functions/filepro-fieldcount.xml:1.3 Mon Jan 8 00:35:01 2007 +++ phpdoc/en/reference/filepro/functions/filepro-fieldcount.xml Mon Jan 8 00:47:18 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.filepro-fieldcount"> <refnamediv> <refname>filepro_fieldcount</refname> <refpurpose>Find out how many fields are in a filePro database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>filepro_fieldcount</methodname> <void/> @@ -15,8 +15,20 @@ Returns the number of fields (columns) in the opened filePro database. </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of fields in the opened filePro database, or &false; on + errors. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>filepro</function>. + <simplelist> + <member><function>filepro</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filepro/functions/filepro-fieldname.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/filepro/functions/filepro-fieldname.xml diff -u phpdoc/en/reference/filepro/functions/filepro-fieldname.xml:1.3 phpdoc/en/reference/filepro/functions/filepro-fieldname.xml:1.4 --- phpdoc/en/reference/filepro/functions/filepro-fieldname.xml:1.3 Mon Jan 8 00:35:01 2007 +++ phpdoc/en/reference/filepro/functions/filepro-fieldname.xml Mon Jan 8 00:47:18 2007 @@ -1,19 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.filepro-fieldname"> <refnamediv> <refname>filepro_fieldname</refname> <refpurpose>Gets the name of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>filepro_fieldname</methodname> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> </methodsynopsis> <para> - Returns the name of the field corresponding - to <parameter>field_number</parameter>. + Returns the name of the field corresponding to + <parameter>field_number</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>field_number</parameter></term> + <listitem> + <para> + The field number. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the name of the field as a string, or &false; on errors. </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filepro/functions/filepro-fieldtype.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/filepro/functions/filepro-fieldtype.xml diff -u phpdoc/en/reference/filepro/functions/filepro-fieldtype.xml:1.3 phpdoc/en/reference/filepro/functions/filepro-fieldtype.xml:1.4 --- phpdoc/en/reference/filepro/functions/filepro-fieldtype.xml:1.3 Mon Jan 8 00:35:01 2007 +++ phpdoc/en/reference/filepro/functions/filepro-fieldtype.xml Mon Jan 8 00:47:18 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.filepro-fieldtype"> <refnamediv> <refname>filepro_fieldtype</refname> <refpurpose>Gets the type of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>filepro_fieldtype</methodname> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> @@ -15,6 +15,27 @@ Returns the edit type of the field corresponding to <parameter>field_number</parameter>. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>field_number</parameter></term> + <listitem> + <para> + The field number. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the edit type of the field as a string, or &false; on errors. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filepro/functions/filepro-fieldwidth.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/filepro/functions/filepro-fieldwidth.xml diff -u phpdoc/en/reference/filepro/functions/filepro-fieldwidth.xml:1.3 phpdoc/en/reference/filepro/functions/filepro-fieldwidth.xml:1.4 --- phpdoc/en/reference/filepro/functions/filepro-fieldwidth.xml:1.3 Mon Jan 8 00:35:01 2007 +++ phpdoc/en/reference/filepro/functions/filepro-fieldwidth.xml Mon Jan 8 00:47:18 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.filepro-fieldwidth"> <refnamediv> <refname>filepro_fieldwidth</refname> <refpurpose>Gets the width of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>filepro_fieldwidth</methodname> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> @@ -15,6 +15,27 @@ Returns the width of the field corresponding to <parameter>field_number</parameter>. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>field_number</parameter></term> + <listitem> + <para> + The field number. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the width of the field as a integer, or &false; on errors. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filepro/functions/filepro-retrieve.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/filepro/functions/filepro-retrieve.xml diff -u phpdoc/en/reference/filepro/functions/filepro-retrieve.xml:1.4 phpdoc/en/reference/filepro/functions/filepro-retrieve.xml:1.5 --- phpdoc/en/reference/filepro/functions/filepro-retrieve.xml:1.4 Mon Jan 8 00:35:01 2007 +++ phpdoc/en/reference/filepro/functions/filepro-retrieve.xml Mon Jan 8 00:47:18 2007 @@ -1,28 +1,53 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.filepro-retrieve"> <refnamediv> <refname>filepro_retrieve</refname> <refpurpose>Retrieves data from a filePro database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>filepro_retrieve</methodname> <methodparam><type>int</type><parameter>row_number</parameter></methodparam> <methodparam><type>int</type><parameter>field_number</parameter></methodparam> </methodsynopsis> <para> - Returns the data from the specified location in the database. The - <parameter>row_number</parameter> parameter must be between zero - and the total number of rows minus one - (0..<function>filepro_rowcount</function> - 1). Likewise, - <parameter>field_number</parameter> accepts values between zero and - the total number of fields minus one - (0..<function>filepro_fieldcount</function> - 1) + Returns the data from the specified location in the database. </para> &note.sm.uidcheck; </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>row_number</parameter></term> + <listitem> + <para> + The row number. Must be between zero and the total number of rows + minus one (0..<function>filepro_rowcount</function> - 1) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field_number</parameter></term> + <listitem> + <para> + The field number. Accepts values between zero and the total number of + fields minus one (0..<function>filepro_fieldcount</function> - 1) + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the specified data, or &false; on errors. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filepro/functions/filepro-rowcount.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/filepro/functions/filepro-rowcount.xml diff -u phpdoc/en/reference/filepro/functions/filepro-rowcount.xml:1.3 phpdoc/en/reference/filepro/functions/filepro-rowcount.xml:1.4 --- phpdoc/en/reference/filepro/functions/filepro-rowcount.xml:1.3 Mon Jan 8 00:35:01 2007 +++ phpdoc/en/reference/filepro/functions/filepro-rowcount.xml Mon Jan 8 00:47:18 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.filepro-rowcount"> <refnamediv> <refname>filepro_rowcount</refname> <refpurpose>Find out how many rows are in a filePro database</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>filepro_rowcount</methodname> <void/> @@ -15,8 +15,20 @@ Returns the number of rows in the opened filePro database. </para> &note.sm.uidcheck; + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the number of rows in the opened filePro database, or &false; on + errors. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>filepro</function>. + <simplelist> + <member><function>filepro</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/filepro/functions/filepro.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/filepro/functions/filepro.xml diff -u phpdoc/en/reference/filepro/functions/filepro.xml:1.3 phpdoc/en/reference/filepro/functions/filepro.xml:1.4 --- phpdoc/en/reference/filepro/functions/filepro.xml:1.3 Mon Jan 8 00:35:01 2007 +++ phpdoc/en/reference/filepro/functions/filepro.xml Mon Jan 8 00:47:18 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.filepro"> <refnamediv> <refname>filepro</refname> <refpurpose>Read and verify the map file</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>filepro</methodname> <methodparam><type>string</type><parameter>directory</parameter></methodparam> @@ -21,6 +21,27 @@ </para> &note.sm.uidcheck; </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>directory</parameter></term> + <listitem> + <para> + The map directory. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file