From ecf42293a5fa5e05ce62a4f4eada208c0c4d49b3 Mon Sep 17 00:00:00 2001
From: Chris Wright <daverandom@php.net>
Date: Mon, 1 Sep 2014 17:12:24 +0000
Subject: [PATCH] Improve HttpQueryString::get() docs

--
Provided by Michael C (wafflestealer654@gmail.com)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334709 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/http/HttpQueryString/get.xml | 118 +++++--------------------
 1 file changed, 22 insertions(+), 96 deletions(-)

diff --git a/reference/http/HttpQueryString/get.xml b/reference/http/HttpQueryString/get.xml
index 850d86f5bc..d885bc15ea 100644
--- a/reference/http/HttpQueryString/get.xml
+++ b/reference/http/HttpQueryString/get.xml
@@ -2,10 +2,12 @@
 <!-- $Revision$ -->
 <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
 <refentry xml:id="httpquerystring.get" xmlns="http://docbook.org/ns/docbook">
+
  <refnamediv>
   <refname>HttpQueryString::get</refname>
-  <refpurpose>Get (part of) query string</refpurpose>
+  <refpurpose>Get the query string or a part thereof</refpurpose>
  </refnamediv>
+
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
@@ -16,17 +18,9 @@
    <methodparam choice="opt"><type>mixed</type><parameter>defval</parameter><initializer>&null;</initializer></methodparam>
    <methodparam choice="opt"><type>bool</type><parameter>delete</parameter><initializer>false</initializer></methodparam>
   </methodsynopsis>
-
-  <para>
-   Get (part of) the query string.
-  </para>
-  <para>
-   The type parameter is either one of the <link linkend="http.httpquerystring.constants">HttpQueryString::TYPE_* constants</link> or a type abbreviation like
-   "b" for bool, "i" for int, "f" for float, "s" for string, "a" 
-   for array and "o" for a stdClass object.
-  </para>
-
+  <para>Get the query string or a part thereof</para>
  </refsect1>
+
  <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
@@ -35,7 +29,7 @@
      <term><parameter>key</parameter></term>
      <listitem>
       <para>
-       key of the query string param to retrieve
+       Key of the query string parameter to retrieve
       </para>
      </listitem>
     </varlistentry>
@@ -43,7 +37,15 @@
      <term><parameter>type</parameter></term>
      <listitem>
       <para>
-       which variable type to enforce
+       Variable type to enforce for the returned value
+      </para>
+      <para>
+       Either one of the
+       <link linkend="http.httpquerystring.constants">
+        HttpQueryString::TYPE_* constants
+       </link>
+       or a type abbreviation - "b" for bool, "i" for int, "f" for float,
+       "s" for string, "a" for array and "o" for a stdClass object.
       </para>
      </listitem>
     </varlistentry>
@@ -51,7 +53,7 @@
      <term><parameter>defval</parameter></term>
      <listitem>
       <para>
-       default value if key does not exist
+       Default value if <parameter>key</parameter> does not exist
       </para>
      </listitem>
     </varlistentry>
@@ -59,100 +61,24 @@
      <term><parameter>delete</parameter></term>
      <listitem>
       <para>
-       whether to remove the key/value pair from the query string
+       Whether to remove <parameter>key</parameter> from the query string
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </para>
  </refsect1>
+
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns the value of the query string param or the whole query string if no key was specified on success or defval if key does not exist.
+   Returns the value of the query string param or the whole query string if
+   <parameter>key</parameter> was not specified. Returns
+   <parameter>defval</parameter> if the specified <parameter>key</parameter>
+   does not exist.
   </para>
  </refsect1>
 
- <!-- Use when ERRORS exist
- <refsect1 role="errors">
-  &reftitle.errors;
-  <para>
-   When does this function throw E_* level errors, or exceptions?
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when a CHANGELOG exists
- <refsect1 role="changelog">
-  &reftitle.changelog;
-  <para>
-   <informaltable>
-    <tgroup cols="2">
-     <thead>
-      <row>
-       <entry>&Version;</entry>
-       <entry>&Description;</entry>
-      </row>
-     </thead>
-     <tbody>
-      <row>
-       <entry>Enter the PHP version of change here</entry>
-       <entry>Description of change</entry>
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when examples exist
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title>A <function>HttpQueryString::get</function> example</title>
-    <para>
-     Any text that describes the purpose of the example, or
-     what goes on in the example should go here (inside the
-     <example> tag, not out
-    </para>
-    <programlisting role="php">
-<![CDATA[
-<?php
-if ($anexample === true) {
-    echo 'Use the PEAR Coding Standards';
-}
-?>
-]]>
-    </programlisting>
-    &example.outputs;
-    <screen>
-<![CDATA[
-Use the PEAR Coding Standards
-]]>
-    </screen>
-   </example>
-  </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>
-   </simplelist>
-  </para>
- </refsect1>
- -->
-
-
 </refentry>
 
 <!-- Keep this comment at the end of the file