didou Mon Feb 26 01:40:44 2007 UTC
Modified files: /phpdoc/en/reference/exec/functions passthru.xml proc-close.xml proc-terminate.xml /phpdoc/en/reference/gnupg/functions gnupg-seterrormode.xml /phpdoc/en/reference/mysql/functions mysql-field-seek.xml /phpdoc/en/reference/paradox/functions px-update-record.xml /phpdoc/en/reference/pdo_sqlite/functions PDO-sqliteCreateAggregate.xml PDO-sqliteCreateFunction.xml /phpdoc/en/reference/sesam/functions sesam-disconnect.xml /phpdoc/en/reference/swish/functions swishsearch-resetlimit.xml swishsearch-setlimit.xml swishsearch-setphrasedelimiter.xml swishsearch-setsort.xml swishsearch-setstructure.xml Log: Fix return values
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/exec/functions/passthru.xml?r1=1.9&r2=1.10&diff_format=u Index: phpdoc/en/reference/exec/functions/passthru.xml diff -u phpdoc/en/reference/exec/functions/passthru.xml:1.9 phpdoc/en/reference/exec/functions/passthru.xml:1.10 --- phpdoc/en/reference/exec/functions/passthru.xml:1.9 Fri Apr 8 23:18:40 2005 +++ phpdoc/en/reference/exec/functions/passthru.xml Mon Feb 26 01:40:43 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.9 $ --> +<!-- $Revision: 1.10 $ --> <!-- splitted from ./en/functions/exec.xml, last change in rev 1.2 --> <refentry id="function.passthru"> <refnamediv> @@ -54,6 +54,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="notes"> &reftitle.notes; &warn.escapeshell; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/exec/functions/proc-close.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/exec/functions/proc-close.xml diff -u phpdoc/en/reference/exec/functions/proc-close.xml:1.8 phpdoc/en/reference/exec/functions/proc-close.xml:1.9 --- phpdoc/en/reference/exec/functions/proc-close.xml:1.8 Fri Apr 8 23:18:40 2005 +++ phpdoc/en/reference/exec/functions/proc-close.xml Mon Feb 26 01:40:43 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <!-- splitted from ./en/functions/exec.xml, last change in rev 1.28 --> <refentry id='function.proc-close'> <refnamediv> @@ -41,6 +41,14 @@ </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the termination status of the process that was run. + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/exec/functions/proc-terminate.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/exec/functions/proc-terminate.xml diff -u phpdoc/en/reference/exec/functions/proc-terminate.xml:1.8 phpdoc/en/reference/exec/functions/proc-terminate.xml:1.9 --- phpdoc/en/reference/exec/functions/proc-terminate.xml:1.8 Wed Feb 14 19:48:18 2007 +++ phpdoc/en/reference/exec/functions/proc-terminate.xml Mon Feb 26 01:40:43 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id='function.proc-terminate'> <refnamediv> <refname>proc_terminate</refname> @@ -20,13 +20,6 @@ for the process to terminate. </para> <para> - The optional - <parameter>signal</parameter> is only useful on <acronym>POSIX</acronym> - operating systems; you may specify a signal to send to the process using - the <literal>kill(2)</literal> system call. The default is - <literal>SIGTERM</literal>. - </para> - <para> <function>proc_terminate</function> allows you terminate the process and continue with other tasks. You may poll the process (to see if it has stopped yet) by using the <function>proc_get_status</function> function. @@ -35,6 +28,42 @@ </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>process</parameter></term> + <listitem> + <para> + The <function>proc_open</function> <type>resource</type> that will + be closed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>signal</parameter></term> + <listitem> + <para> + This optional parameter is only useful on <acronym>POSIX</acronym> + operating systems; you may specify a signal to send to the process + using the <literal>kill(2)</literal> system call. The default is + <literal>SIGTERM</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the termination status of the process that was run. + </para> + </refsect1> + + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/gnupg/functions/gnupg-seterrormode.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/gnupg/functions/gnupg-seterrormode.xml diff -u phpdoc/en/reference/gnupg/functions/gnupg-seterrormode.xml:1.4 phpdoc/en/reference/gnupg/functions/gnupg-seterrormode.xml:1.5 --- phpdoc/en/reference/gnupg/functions/gnupg-seterrormode.xml:1.4 Fri Dec 2 21:41:41 2005 +++ phpdoc/en/reference/gnupg/functions/gnupg-seterrormode.xml Mon Feb 26 01:40:43 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.gnupg-seterrormode"> <refnamediv> <refname>gnupg_seterrormode</refname> @@ -23,6 +23,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/mysql/functions/mysql-field-seek.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/mysql/functions/mysql-field-seek.xml diff -u phpdoc/en/reference/mysql/functions/mysql-field-seek.xml:1.7 phpdoc/en/reference/mysql/functions/mysql-field-seek.xml:1.8 --- phpdoc/en/reference/mysql/functions/mysql-field-seek.xml:1.7 Fri Jun 24 09:11:41 2005 +++ phpdoc/en/reference/mysql/functions/mysql-field-seek.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.mysql-field-seek"> <refnamediv> <refname>mysql_field_seek</refname> @@ -31,6 +31,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/paradox/functions/px-update-record.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/paradox/functions/px-update-record.xml diff -u phpdoc/en/reference/paradox/functions/px-update-record.xml:1.3 phpdoc/en/reference/paradox/functions/px-update-record.xml:1.4 --- phpdoc/en/reference/paradox/functions/px-update-record.xml:1.3 Thu Mar 30 15:50:47 2006 +++ phpdoc/en/reference/paradox/functions/px-update-record.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/paradox.xml, last change in rev --> <refentry id="function.px-update-record"> <refnamediv> @@ -68,6 +68,12 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> <refsect1 role="seealso"> &reftitle.seealso; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateAggregate.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateAggregate.xml diff -u phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateAggregate.xml:1.5 phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateAggregate.xml:1.6 --- phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateAggregate.xml:1.5 Fri Feb 2 00:26:54 2007 +++ phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateAggregate.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.PDO-sqliteCreateAggregate"> <refnamediv> <refname>PDO->sqliteCreateAggregate()</refname> @@ -121,6 +121,13 @@ </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </par> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateFunction.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateFunction.xml diff -u phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateFunction.xml:1.5 phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateFunction.xml:1.6 --- phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateFunction.xml:1.5 Fri Feb 2 00:26:54 2007 +++ phpdoc/en/reference/pdo_sqlite/functions/PDO-sqliteCreateFunction.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <refentry id="function.PDO-sqliteCreateFunction"> <refnamediv> <refname>PDO->sqliteCreateFunction()</refname> @@ -72,6 +72,13 @@ &sqlite.param-compat; </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </par> + </refsect1> + <refsect1 role="examples"> &reftitle.examples; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/sesam/functions/sesam-disconnect.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/sesam/functions/sesam-disconnect.xml diff -u phpdoc/en/reference/sesam/functions/sesam-disconnect.xml:1.6 phpdoc/en/reference/sesam/functions/sesam-disconnect.xml:1.7 --- phpdoc/en/reference/sesam/functions/sesam-disconnect.xml:1.6 Sat Feb 3 22:18:05 2007 +++ phpdoc/en/reference/sesam/functions/sesam-disconnect.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <refentry id="function.sesam-disconnect"> <refnamediv> <refname>sesam_disconnect</refname> @@ -32,8 +32,8 @@ </para> </refsect1> - <refsect1 role="examples"> - &reftitle.examples; + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> Always returns &true;. </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/functions/swishsearch-resetlimit.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/swish/functions/swishsearch-resetlimit.xml diff -u phpdoc/en/reference/swish/functions/swishsearch-resetlimit.xml:1.2 phpdoc/en/reference/swish/functions/swishsearch-resetlimit.xml:1.3 --- phpdoc/en/reference/swish/functions/swishsearch-resetlimit.xml:1.2 Wed Feb 14 13:19:02 2007 +++ phpdoc/en/reference/swish/functions/swishsearch-resetlimit.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.swishsearch-resetlimit"> <refnamediv> <refname>SwishSearch->resetLimit</refname> @@ -17,6 +17,12 @@ <xref linkend="function.swishsearch-setlimit" />. </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/functions/swishsearch-setlimit.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/swish/functions/swishsearch-setlimit.xml diff -u phpdoc/en/reference/swish/functions/swishsearch-setlimit.xml:1.2 phpdoc/en/reference/swish/functions/swishsearch-setlimit.xml:1.3 --- phpdoc/en/reference/swish/functions/swishsearch-setlimit.xml:1.2 Wed Feb 14 13:19:02 2007 +++ phpdoc/en/reference/swish/functions/swishsearch-setlimit.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.swishsearch-setlimit"> <refnamediv> <refname>SwishSearch->setLimit</refname> @@ -46,6 +46,12 @@ </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> <refsect1 role="errors"> &reftitle.errors; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/functions/swishsearch-setphrasedelimiter.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/swish/functions/swishsearch-setphrasedelimiter.xml diff -u phpdoc/en/reference/swish/functions/swishsearch-setphrasedelimiter.xml:1.2 phpdoc/en/reference/swish/functions/swishsearch-setphrasedelimiter.xml:1.3 --- phpdoc/en/reference/swish/functions/swishsearch-setphrasedelimiter.xml:1.2 Wed Feb 14 13:19:02 2007 +++ phpdoc/en/reference/swish/functions/swishsearch-setphrasedelimiter.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.swishsearch-setphrasedelimiter"> <refnamediv> <refname>SwishSearch->setPhraseDelimiter</refname> @@ -28,6 +28,12 @@ </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/functions/swishsearch-setsort.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/swish/functions/swishsearch-setsort.xml diff -u phpdoc/en/reference/swish/functions/swishsearch-setsort.xml:1.2 phpdoc/en/reference/swish/functions/swishsearch-setsort.xml:1.3 --- phpdoc/en/reference/swish/functions/swishsearch-setsort.xml:1.2 Wed Feb 14 13:19:02 2007 +++ phpdoc/en/reference/swish/functions/swishsearch-setsort.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.swishsearch-setsort"> <refnamediv> <refname>SwishSearch->setSort</refname> @@ -31,6 +31,12 @@ </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> <refsect1 role="examples"> &reftitle.examples; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/swish/functions/swishsearch-setstructure.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/swish/functions/swishsearch-setstructure.xml diff -u phpdoc/en/reference/swish/functions/swishsearch-setstructure.xml:1.4 phpdoc/en/reference/swish/functions/swishsearch-setstructure.xml:1.5 --- phpdoc/en/reference/swish/functions/swishsearch-setstructure.xml:1.4 Wed Feb 14 13:20:22 2007 +++ phpdoc/en/reference/swish/functions/swishsearch-setstructure.xml Mon Feb 26 01:40:44 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.swishsearch-setstructure"> <refnamediv> <refname>SwishSearch->setStructure</refname> @@ -74,6 +74,12 @@ </itemizedlist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> <refsect1 role="examples"> &reftitle.examples; <para>