Fix return values

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@230799 c90b9560-bf6c-de11-be94-00142212c4b1
2025-03-16 00:48:54 +00:00 · 2007-02-26 01:40:44 +00:00 · 2007-02-26 01:40:44 +00:00 · 01d2718356
commit 01d2718356
parent 94b7d99d01
14 changed files with 131 additions and 23 deletions
--- a/reference/exec/functions/passthru.xml
+++ b/reference/exec/functions/passthru.xml
@ -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;
--- a/reference/exec/functions/proc-close.xml
+++ b/reference/exec/functions/proc-close.xml
@ -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
--- a/reference/exec/functions/proc-terminate.xml
+++ b/reference/exec/functions/proc-terminate.xml
@ -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>
@ -19,13 +19,6 @@
   <function>proc_terminate</function> returns immediately and does not wait
   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
@ -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>
--- a/reference/gnupg/functions/gnupg-seterrormode.xml
+++ b/reference/gnupg/functions/gnupg-seterrormode.xml
@ -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>
--- a/reference/mysql/functions/mysql-field-seek.xml
+++ b/reference/mysql/functions/mysql-field-seek.xml
@ -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>
--- a/reference/paradox/functions/px-update-record.xml
+++ b/reference/paradox/functions/px-update-record.xml
@ -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;
--- a/reference/pdo_sqlite/functions/PDO-sqliteCreateAggregate.xml
+++ b/reference/pdo_sqlite/functions/PDO-sqliteCreateAggregate.xml
@ -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>
--- a/reference/pdo_sqlite/functions/PDO-sqliteCreateFunction.xml
+++ b/reference/pdo_sqlite/functions/PDO-sqliteCreateFunction.xml
@ -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>
--- a/reference/sesam/functions/sesam-disconnect.xml
+++ b/reference/sesam/functions/sesam-disconnect.xml
@ -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>
--- a/reference/swish/functions/swishsearch-resetlimit.xml
+++ b/reference/swish/functions/swishsearch-resetlimit.xml
@ -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-&gt;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>
--- a/reference/swish/functions/swishsearch-setlimit.xml
+++ b/reference/swish/functions/swishsearch-setlimit.xml
@ -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-&gt;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>
--- a/reference/swish/functions/swishsearch-setphrasedelimiter.xml
+++ b/reference/swish/functions/swishsearch-setphrasedelimiter.xml
@ -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-&gt;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>
--- a/reference/swish/functions/swishsearch-setsort.xml
+++ b/reference/swish/functions/swishsearch-setsort.xml
@ -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-&gt;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>
--- a/reference/swish/functions/swishsearch-setstructure.xml
+++ b/reference/swish/functions/swishsearch-setstructure.xml
@ -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-&gt;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>