mike Wed Apr 18 13:14:34 2007 UTC
Modified files:
/phpdoc/en/reference/http/functions/parsers http-parse-cookie.xml
http-parse-headers.xml
http-parse-message.xml
http-parse-params.xml
/phpdoc/en/reference/http/functions/persistenthandles
http-persistent-handles-clean.xml
http-persistent-handles-count.xml
http-persistent-handles-ident.xml
/phpdoc/en/reference/http/functions/urls http-build-str.xml
http-build-url.xml
Log:
- reviewed remaining functions
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/parsers/http-parse-cookie.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/http/functions/parsers/http-parse-cookie.xml
diff -u phpdoc/en/reference/http/functions/parsers/http-parse-cookie.xml:1.3
phpdoc/en/reference/http/functions/parsers/http-parse-cookie.xml:1.4
--- phpdoc/en/reference/http/functions/parsers/http-parse-cookie.xml:1.3
Wed Sep 6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/parsers/http-parse-cookie.xml Wed Apr
18 13:14:34 2007
@@ -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 @@
</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>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/parsers/http-parse-headers.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/parsers/http-parse-headers.xml
diff -u phpdoc/en/reference/http/functions/parsers/http-parse-headers.xml:1.2
phpdoc/en/reference/http/functions/parsers/http-parse-headers.xml:1.3
--- phpdoc/en/reference/http/functions/parsers/http-parse-headers.xml:1.2
Wed Sep 6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/parsers/http-parse-headers.xml Wed Apr
18 13:14:34 2007
@@ -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 @@
</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>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/parsers/http-parse-message.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/http/functions/parsers/http-parse-message.xml
diff -u phpdoc/en/reference/http/functions/parsers/http-parse-message.xml:1.4
phpdoc/en/reference/http/functions/parsers/http-parse-message.xml:1.5
--- phpdoc/en/reference/http/functions/parsers/http-parse-message.xml:1.4
Sun Oct 15 03:44:37 2006
+++ phpdoc/en/reference/http/functions/parsers/http-parse-message.xml Wed Apr
18 13:14:34 2007
@@ -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 @@
</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>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/parsers/http-parse-params.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/http/functions/parsers/http-parse-params.xml
diff -u phpdoc/en/reference/http/functions/parsers/http-parse-params.xml:1.3
phpdoc/en/reference/http/functions/parsers/http-parse-params.xml:1.4
--- phpdoc/en/reference/http/functions/parsers/http-parse-params.xml:1.3
Tue Mar 27 10:13:49 2007
+++ phpdoc/en/reference/http/functions/parsers/http-parse-params.xml Wed Apr
18 13:14:34 2007
@@ -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 @@
</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>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml?r1=1.1&r2=1.2&diff_format=u
Index:
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml
diff -u
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml:1.1
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml:1.2
---
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml:1.1
Thu Mar 29 15:32:01 2007
+++
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-clean.xml
Wed Apr 18 13:14:34 2007
@@ -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>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-count.xml?r1=1.1&r2=1.2&diff_format=u
Index:
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-count.xml
diff -u
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-count.xml:1.1
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-count.xml:1.2
---
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-count.xml:1.1
Wed Mar 28 06:33:29 2007
+++
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-count.xml
Wed Apr 18 13:14:34 2007
@@ -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 @@
</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>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml?r1=1.2&r2=1.3&diff_format=u
Index:
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml
diff -u
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml:1.2
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml:1.3
---
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml:1.2
Thu Mar 29 15:32:01 2007
+++
phpdoc/en/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml
Wed Apr 18 13:14:34 2007
@@ -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 @@
</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>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/urls/http-build-str.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/urls/http-build-str.xml
diff -u phpdoc/en/reference/http/functions/urls/http-build-str.xml:1.2
phpdoc/en/reference/http/functions/urls/http-build-str.xml:1.3
--- phpdoc/en/reference/http/functions/urls/http-build-str.xml:1.2 Wed Sep
6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/urls/http-build-str.xml Wed Apr 18
13:14:34 2007
@@ -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 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>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/urls/http-build-url.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/urls/http-build-url.xml
diff -u phpdoc/en/reference/http/functions/urls/http-build-url.xml:1.2
phpdoc/en/reference/http/functions/urls/http-build-url.xml:1.3
--- phpdoc/en/reference/http/functions/urls/http-build-url.xml:1.2 Wed Sep
6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/urls/http-build-url.xml Wed Apr 18
13:14:34 2007
@@ -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 @@
</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>