From 6fd84be3e5806b64ddcdc48dd369f7081fa7f6cc Mon Sep 17 00:00:00 2001
From: Michael Wallner <mike@php.net>
Date: Wed, 18 Apr 2007 13:14:34 +0000
Subject: [PATCH] - reviewed remaining functions

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@234022 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../functions/parsers/http-parse-cookie.xml   | 21 +++++++++----------
 .../functions/parsers/http-parse-headers.xml  | 12 +++++------
 .../functions/parsers/http-parse-message.xml  | 14 ++++++-------
 .../functions/parsers/http-parse-params.xml   | 15 +++++++------
 .../http-persistent-handles-clean.xml         | 11 ++++------
 .../http-persistent-handles-count.xml         | 10 +++------
 .../http-persistent-handles-ident.xml         | 11 +++-------
 .../http/functions/urls/http-build-str.xml    | 10 +++------
 .../http/functions/urls/http-build-url.xml    |  8 +++----
 9 files changed, 44 insertions(+), 68 deletions(-)

diff --git a/reference/http/functions/parsers/http-parse-cookie.xml b/reference/http/functions/parsers/http-parse-cookie.xml
index c9a942ee0e..e7da5a2e4b 100644
--- a/reference/http/functions/parsers/http-parse-cookie.xml
+++ b/reference/http/functions/parsers/http-parse-cookie.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
 <refentry id="function.http-parse-cookie">
  <refnamediv>
@@ -10,7 +10,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>object</type><methodname>http_parse_cookie</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>cookie</parameter></methodparam>
+   <methodparam><type>string</type><parameter>cookie</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
    <methodparam choice="opt"><type>array</type><parameter>allowed_extras</parameter></methodparam>
   </methodsynopsis>
@@ -26,7 +26,7 @@
      <term><parameter>cookie</parameter></term>
      <listitem>
       <para>
-       String containing the value of a <literal>Set-Cookie</literal> response header
+       string containing the value of a <literal>Set-Cookie</literal> response header
       </para>
      </listitem>
     </varlistentry>
@@ -34,7 +34,7 @@
      <term><parameter>flags</parameter></term>
      <listitem>
       <para>
-       Parse flags
+       parse flags (<link linkend="http.constants.cookie"><constant>HTTP_COOKIE_PARSE_RAW</constant></link>)
       </para>
      </listitem>
     </varlistentry>
@@ -42,8 +42,8 @@
      <term><parameter>allowed_extras</parameter></term>
      <listitem>
       <para>
-       Array containing recognized <emphasis>extra</emphasis> keys.
-       By default all unknown keys will be treated as cookie names.
+       array containing recognized <emphasis>extra</emphasis> keys;
+       by default all unknown keys will be treated as cookie names
       </para>
      </listitem>
     </varlistentry>
@@ -53,7 +53,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an stdClass like shown in the example on success or FALSE on failure.
+   Returns a stdClass object on success or &false; on failure.
   </para>
  </refsect1>
 
@@ -132,17 +132,16 @@ stdClass Object
  </refsect1>
 
 
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>http_parse_headers</function></member>
+    <member><function>http_parse_message</function></member>
+    <member><function>http_build_cookie</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>
diff --git a/reference/http/functions/parsers/http-parse-headers.xml b/reference/http/functions/parsers/http-parse-headers.xml
index 2cbf4406c2..28691bfb18 100644
--- a/reference/http/functions/parsers/http-parse-headers.xml
+++ b/reference/http/functions/parsers/http-parse-headers.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
 <refentry id="function.http-parse-headers">
  <refnamediv>
@@ -24,7 +24,7 @@
      <term><parameter>header</parameter></term>
      <listitem>
       <para>
-       String containing HTTP headers
+       string containing HTTP headers
       </para>
      </listitem>
     </varlistentry>
@@ -34,7 +34,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns an array on success, or FALSE on failure.
+   Returns an array on success, or &false; on failure.
   </para>
  </refsect1>
 
@@ -112,17 +112,15 @@ Array
  </refsect1>
 
 
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>http_parse_message</function></member>
+    <member><function>http_parse_cookie</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>
diff --git a/reference/http/functions/parsers/http-parse-message.xml b/reference/http/functions/parsers/http-parse-message.xml
index 5bfe43eab8..a9dc7863ab 100644
--- a/reference/http/functions/parsers/http-parse-message.xml
+++ b/reference/http/functions/parsers/http-parse-message.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
 <refentry id="function.http-parse-message">
  <refnamediv>
   <refname>http_parse_message</refname>
-  <refpurpose>Parse the HTTP message</refpurpose>
+  <refpurpose>Parse HTTP messages</refpurpose>
  </refnamediv>
  <refsect1 role="description">
   &reftitle.description;
@@ -25,7 +25,7 @@
      <term><parameter>message</parameter></term>
      <listitem>
       <para>
-       String containing a single HTTP message or several consecutive HTTP messages
+       string containing a single HTTP message or several consecutive HTTP messages
       </para>
      </listitem>
     </varlistentry>
@@ -35,7 +35,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   A hierarchical <type>object</type> structure of the parsed messages.
+   Returns a hierarchical <type>object</type> structure of the parsed messages.
   </para>
  </refsect1>
 
@@ -122,17 +122,15 @@ stdClass object
  </refsect1>
 
 
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>http_parse_headers</function></member>
+    <member>the <link linkend="http.HttpMessage"><classname>HttpMessage</classname></link> class</member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>
diff --git a/reference/http/functions/parsers/http-parse-params.xml b/reference/http/functions/parsers/http-parse-params.xml
index f1d84dbeec..0c09a3477a 100644
--- a/reference/http/functions/parsers/http-parse-params.xml
+++ b/reference/http/functions/parsers/http-parse-params.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
 <refentry id="function.http-parse-params">
  <refnamediv>
@@ -10,7 +10,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>object</type><methodname>http_parse_params</methodname>
-   <methodparam choice="opt"><type>string</type><parameter>param</parameter></methodparam>
+   <methodparam><type>string</type><parameter>param</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>flags = HTTP_PARAMS_DEFAULT</parameter></methodparam>
   </methodsynopsis>
   <para>
@@ -18,7 +18,7 @@
   </para>
   <para>
    See the <link linkend="http.constants.params">params parsing constants table</link> for possible 
-   values of the <varname>flags</varname> argument.
+   values of the <parameter>flags</parameter> argument.
   </para>
  </refsect1>
  <refsect1 role="parameters">
@@ -47,7 +47,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns parameter list.
+   Returns parameter list as stdClass object.
   </para>
  </refsect1>
 
@@ -120,17 +120,16 @@ object(stdClass)#1 (1) {
  </refsect1>
 
 
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>http_parse_headers</function></member>
+    <member><function>http_parse_cookie</function></member>
+    <member><function>http_parse_message</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>
diff --git a/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml b/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml
index 29f6673b00..8bc716f0f0 100644
--- a/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml
+++ b/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.http-persistent-handles-clean">
  <refnamediv>
   <refname>http_persistent_handles_clean</refname>
@@ -11,11 +11,9 @@
    <type>string</type><methodname>http_persistent_handles_clean</methodname>
    <methodparam choice="opt"><type>string</type><parameter>ident</parameter></methodparam>
   </methodsynopsis>
-
   <para>
    Clean up (close) persistent handles, optionally identified with ident.
   </para>
-
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;
@@ -89,17 +87,16 @@
   </para>
  </refsect1>
 -->
- <!-- Use when adding See Also links
+ 
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>http_persistent_handles_ident</function></member>
+    <member><function>http_persistent_handles_count</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>
diff --git a/reference/http/functions/persistenthandles/http-persistent-handles-count.xml b/reference/http/functions/persistenthandles/http-persistent-handles-count.xml
index 62e7deec21..209e49646f 100644
--- a/reference/http/functions/persistenthandles/http-persistent-handles-count.xml
+++ b/reference/http/functions/persistenthandles/http-persistent-handles-count.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry id="function.http-persistent-handles-count">
  <refnamediv>
   <refname>http_persistent_handles_count</refname>
@@ -11,11 +11,9 @@
    <type>object</type><methodname>http_persistent_handles_count</methodname>
    <void/>
   </methodsynopsis>
-
   <para>
    List statistics about persistent handles usage.
   </para>
-
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;
@@ -113,17 +111,15 @@ stdClass Object
  </refsect1>
 
 
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>http_persistent_handles_ident</function></member>
+    <member><function>http_persistent_handles_clean</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>
diff --git a/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml b/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml
index e3bbae3296..881431f185 100644
--- a/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml
+++ b/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry id="function.http-persistent-handles-ident">
  <refnamediv>
   <refname>http_persistent_handles_ident</refname>
@@ -11,11 +11,9 @@
    <type>string</type><methodname>http_persistent_handles_ident</methodname>
    <methodparam><type>string</type><parameter>ident</parameter></methodparam>
   </methodsynopsis>
-
   <para>
    Query or define the ident of persistent handles.
   </para>
-
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;
@@ -124,18 +122,15 @@ stdClass Object
   </para>
  </refsect1>
 
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>http_persistent_handles_count</function></member>
+    <member><function>http_persistent_handles_clean</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>
 
diff --git a/reference/http/functions/urls/http-build-str.xml b/reference/http/functions/urls/http-build-str.xml
index d000363037..bc324ac86c 100644
--- a/reference/http/functions/urls/http-build-str.xml
+++ b/reference/http/functions/urls/http-build-str.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
 <refentry id="function.http-build-str">
  <refnamediv>
@@ -14,11 +14,9 @@
    <methodparam choice="opt"><type>string</type><parameter>prefix</parameter></methodparam>
    <methodparam choice="opt"><type>string</type><parameter>arg_separator</parameter></methodparam>
   </methodsynopsis>
-
   <para>
    Opponent to parse_str().
   </para>
-
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;
@@ -125,17 +123,15 @@ Use the PEAR Coding Standards
  -->
 
 
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member>standard <function>http_build_query</function></member>
+    <member><function>http_build_url</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>
diff --git a/reference/http/functions/urls/http-build-url.xml b/reference/http/functions/urls/http-build-url.xml
index b6927996f4..ce540806db 100644
--- a/reference/http/functions/urls/http-build-url.xml
+++ b/reference/http/functions/urls/http-build-url.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
 <refentry id="function.http-build-url">
  <refnamediv>
@@ -137,17 +137,15 @@ ftp://ftp.example.com/pub/files/current/?a=b&a=c
  </refsect1>
 
 
- <!-- Use when adding See Also links
  <refsect1 role="seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
-    <member><function></function></member>
-    <member>Or <link linkend="somethingelse">something else</link></member>
+    <member><function>parse_url</function></member>
+    <member><function>http_build_str</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
 
 
 </refentry>