dbs Wed Apr 20 19:03:08 2005 EDT
Modified files:
/phpdoc/en/reference/ibm_db2/functions db2-free-result.xml
db2-free-stmt.xml
Log:
Add basic documentation for db2_free_* functions.
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-free-result.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-free-result.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-free-result.xml:1.1
phpdoc/en/reference/ibm_db2/functions/db2-free-result.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-free-result.xml:1.1 Tue Apr
12 17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-free-result.xml Wed Apr 20
19:03:07 2005
@@ -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,59 +12,40 @@
&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
- </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>
+ &return.success;
</para>
</refsect1>
- -->
-
<!-- Use when examples exist
<refsect1 role="examples">
@@ -97,19 +78,14 @@
</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>
http://cvs.php.net/diff.php/phpdoc/en/reference/ibm_db2/functions/db2-free-stmt.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ibm_db2/functions/db2-free-stmt.xml
diff -u phpdoc/en/reference/ibm_db2/functions/db2-free-stmt.xml:1.1
phpdoc/en/reference/ibm_db2/functions/db2-free-stmt.xml:1.2
--- phpdoc/en/reference/ibm_db2/functions/db2-free-stmt.xml:1.1 Tue Apr 12
17:12:48 2005
+++ phpdoc/en/reference/ibm_db2/functions/db2-free-stmt.xml Wed Apr 20
19:03:07 2005
@@ -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 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>
