From be854cb94a51266b6fa6ad627886413e83adc826 Mon Sep 17 00:00:00 2001
From: Dan Scott <dbs@php.net>
Date: Wed, 20 Apr 2005 23:03:07 +0000
Subject: [PATCH] Add basic documentation for db2_free_* functions.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@184788 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../ibm_db2/functions/db2-free-result.xml     | 68 ++++++-------------
 reference/ibm_db2/functions/db2-free-stmt.xml | 67 +++++-------------
 2 files changed, 39 insertions(+), 96 deletions(-)

diff --git a/reference/ibm_db2/functions/db2-free-result.xml b/reference/ibm_db2/functions/db2-free-result.xml
index 4258132001..90faeb44cb 100644
--- a/reference/ibm_db2/functions/db2-free-result.xml
+++ b/reference/ibm_db2/functions/db2-free-result.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
 <refentry id="function.db2-free-result">
  <refnamediv>
@@ -12,60 +12,41 @@
   &reftitle.description;
   <methodsynopsis>
    <type>bool</type><methodname>db2_free_result</methodname>
-   <void/>
+   <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+  <para>
+   Frees the system and database resources that are associated with a result
+   set. These resources are freed implicitly when a script finishes, but you
+   can call <function>db2_free_result</function> to explicitly free the result
+   set resources before the end of the script.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
   &reftitle.parameters;
   <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>stmt</parameter></term>
+     <listitem>
+      <para>
+       A valid statement resource.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+
   </para>
  </refsect1>
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   What the function returns, first on success, then on failure. See
-   also the &return.success; entity
+   &return.success;
   </para>
  </refsect1>
 
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
-  &reftitle.exceptions;
-  <para>
-   When does this function throw 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>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
- -->
-
-
  <!-- Use when examples exist
  <refsect1 role="examples">
   &reftitle.examples;
@@ -97,19 +78,14 @@ Use the PEAR Coding Standards
  </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>db2_free_stmt</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>
 
diff --git a/reference/ibm_db2/functions/db2-free-stmt.xml b/reference/ibm_db2/functions/db2-free-stmt.xml
index 6a0a4d68ae..2d8d8fddc1 100644
--- a/reference/ibm_db2/functions/db2-free-stmt.xml
+++ b/reference/ibm_db2/functions/db2-free-stmt.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
 <refentry id="function.db2-free-stmt">
  <refnamediv>
@@ -15,7 +15,14 @@
    <methodparam><type>resource</type><parameter>stmt</parameter></methodparam>
   </methodsynopsis>
 
-  &warn.undocumented.func;
+  &warn.experimental.func;
+
+  <para>
+   Frees the system and database resources that are associated with a statement
+   resource. These resources are freed implicitly when a script finishes, but
+   you can call <function>db2_free_result</function> to explicitly free the
+   statement resources before the end of the script.
+  </para>
 
  </refsect1>
  <refsect1 role="parameters">
@@ -24,58 +31,22 @@
    <variablelist>
     <varlistentry>
      <term><parameter>stmt</parameter></term>
-      <listitem>
-       <para>
-        Its description
-       </para>
-      </listitem>
-     </varlistentry>
+     <listitem>
+      <para>
+       A valid statement resource.
+      </para>
+     </listitem>
+    </varlistentry>
    </variablelist>
   </para>
  </refsect1>
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   What the function returns, first on success, then on failure. See
-   also the &return.success; entity
+   &return.success;
   </para>
  </refsect1>
 
- <!-- Use when EXCEPTIONS exist
- <refsect1 role="exceptions">
-  &reftitle.exceptions;
-  <para>
-   When does this function throw 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>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
- -->
-
-
  <!-- Use when examples exist
  <refsect1 role="examples">
   &reftitle.examples;
@@ -108,18 +79,14 @@ 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><function>db2_free_result</function></member>
    </simplelist>
   </para>
  </refsect1>
- -->
-
 
 </refentry>