From d23e8c74fc24360558eef4f25d1ba487be9c9baf Mon Sep 17 00:00:00 2001
From: Mehdi Achour <didou@php.net>
Date: Sun, 7 Jan 2007 21:19:57 +0000
Subject: [PATCH] Clean up docs and add missing returnvalues

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@226685 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../pdo/functions/PDO-beginTransaction.xml    |  9 +-
 reference/pdo/functions/PDO-commit.xml        |  9 +-
 reference/pdo/functions/PDO-rollBack.xml      |  9 +-
 reference/pdo/functions/PDO-setAttribute.xml  | 10 +-
 .../pdo/functions/PDOStatement-bindColumn.xml |  9 +-
 .../pdo/functions/PDOStatement-bindParam.xml  |  9 +-
 .../pdo/functions/PDOStatement-bindValue.xml  |  9 +-
 .../functions/PDOStatement-closeCursor.xml    | 35 +------
 .../functions/PDOStatement-getAttribute.xml   | 53 +---------
 .../pdo/functions/PDOStatement-rowCount.xml   | 10 +-
 .../functions/PDOStatement-setAttribute.xml   | 96 +------------------
 11 files changed, 74 insertions(+), 184 deletions(-)

diff --git a/reference/pdo/functions/PDO-beginTransaction.xml b/reference/pdo/functions/PDO-beginTransaction.xml
index 765024c658..b72be8dfbe 100644
--- a/reference/pdo/functions/PDO-beginTransaction.xml
+++ b/reference/pdo/functions/PDO-beginTransaction.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <refentry id="function.PDO-beginTransaction">
  <refnamediv>
   <refname>PDO->beginTransaction()</refname>
@@ -34,6 +34,13 @@
 
  </refsect1>
 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
diff --git a/reference/pdo/functions/PDO-commit.xml b/reference/pdo/functions/PDO-commit.xml
index 7c67d14906..1074c8569b 100644
--- a/reference/pdo/functions/PDO-commit.xml
+++ b/reference/pdo/functions/PDO-commit.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <refentry id="function.PDO-commit">
  <refnamediv>
   <refname>PDO->commit()</refname>
@@ -24,6 +24,13 @@
   </para>
  </refsect1>
 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
diff --git a/reference/pdo/functions/PDO-rollBack.xml b/reference/pdo/functions/PDO-rollBack.xml
index 7a972f446c..914601089f 100644
--- a/reference/pdo/functions/PDO-rollBack.xml
+++ b/reference/pdo/functions/PDO-rollBack.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <refentry id="function.PDO-rollBack">
  <refnamediv>
   <refname>PDO->rollBack()</refname>
@@ -36,6 +36,13 @@
   </para>
  </refsect1>
 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
diff --git a/reference/pdo/functions/PDO-setAttribute.xml b/reference/pdo/functions/PDO-setAttribute.xml
index d436bcb9d5..694e86397c 100644
--- a/reference/pdo/functions/PDO-setAttribute.xml
+++ b/reference/pdo/functions/PDO-setAttribute.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <refentry id="function.PDO-setAttribute">
  <refnamediv>
   <refname>PDO->setAttribute()</refname>
@@ -80,6 +80,14 @@
    </itemizedlist>
   </para>
  </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/pdo/functions/PDOStatement-bindColumn.xml b/reference/pdo/functions/PDOStatement-bindColumn.xml
index d100e7d03b..5da089cc45 100644
--- a/reference/pdo/functions/PDOStatement-bindColumn.xml
+++ b/reference/pdo/functions/PDOStatement-bindColumn.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
 <refentry id="function.PDOStatement-bindColumn">
  <refnamediv>
   <refname>PDOStatement->bindColumn()</refname>
@@ -69,6 +69,13 @@
   </para>
  </refsect1>
 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
diff --git a/reference/pdo/functions/PDOStatement-bindParam.xml b/reference/pdo/functions/PDOStatement-bindParam.xml
index 3260b0b1e6..d60c59ef2a 100644
--- a/reference/pdo/functions/PDOStatement-bindParam.xml
+++ b/reference/pdo/functions/PDOStatement-bindParam.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.13 $ -->
+<!-- $Revision: 1.14 $ -->
 <refentry id="function.PDOStatement-bindParam">
  <refnamediv>
   <refname>PDOStatement->bindParam()</refname>
@@ -94,6 +94,13 @@
   </para>
  </refsect1>
 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <example><title>Execute a prepared statement with named placeholders</title>
diff --git a/reference/pdo/functions/PDOStatement-bindValue.xml b/reference/pdo/functions/PDOStatement-bindValue.xml
index fb79f68136..b2d123f370 100644
--- a/reference/pdo/functions/PDOStatement-bindValue.xml
+++ b/reference/pdo/functions/PDOStatement-bindValue.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <refentry id="function.PDOStatement-bindValue">
  <refnamediv>
   <refname>PDOStatement->bindValue()</refname>
@@ -61,6 +61,13 @@
   </para>
  </refsect1>
 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <example><title>Execute a prepared statement with named placeholders</title>
diff --git a/reference/pdo/functions/PDOStatement-closeCursor.xml b/reference/pdo/functions/PDOStatement-closeCursor.xml
index 02534e6f0c..d66ca39d32 100644
--- a/reference/pdo/functions/PDOStatement-closeCursor.xml
+++ b/reference/pdo/functions/PDOStatement-closeCursor.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
+<!-- $Revision: 1.10 $ -->
 <refentry id="function.PDOStatement-closeCursor">
  <refnamediv>
   <refname>PDOStatement->closeCursor()</refname>
@@ -50,39 +50,12 @@ do {
 
  </refsect1>
 
- <!-- Use when ERRORS exist
- <refsect1 role="errors">
-  &reftitle.errors;
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
   <para>
-   When does this function throw E_* level errors, or exceptions?
+   &return.success;
   </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>
- -->
 
  <refsect1 role="examples">
   &reftitle.examples;
diff --git a/reference/pdo/functions/PDOStatement-getAttribute.xml b/reference/pdo/functions/PDOStatement-getAttribute.xml
index a5ce587074..cf813209c8 100644
--- a/reference/pdo/functions/PDOStatement-getAttribute.xml
+++ b/reference/pdo/functions/PDOStatement-getAttribute.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
 <refentry id="function.PDOStatement-getAttribute">
  <refnamediv>
   <refname>PDOStatement->getAttribute()</refname>
@@ -29,61 +29,12 @@
 
  </refsect1>
 
- <!--
- <refsect1 role="parameters">
-  &reftitle.parameters;
-  <para>
-   <variablelist>
-    <varlistentry>
-     <term><parameter>attribute</parameter></term>
-      <listitem>
-       <para>
-        Its description
-       </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
+   Returns the attribute value.
   </para>
  </refsect1>
- -->
-
- <!-- Use when examples exist
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><function>A PDOStatement-getAttribute 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>
- -->
 
  <refsect1 role="seealso">
   &reftitle.seealso;
diff --git a/reference/pdo/functions/PDOStatement-rowCount.xml b/reference/pdo/functions/PDOStatement-rowCount.xml
index 8291400c66..0e9c270ecf 100644
--- a/reference/pdo/functions/PDOStatement-rowCount.xml
+++ b/reference/pdo/functions/PDOStatement-rowCount.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.11 $ -->
+<!-- $Revision: 1.12 $ -->
 <refentry id="function.PDOStatement-rowCount">
  <refnamediv>
   <refname>PDOStatement->rowCount()</refname>
@@ -30,6 +30,14 @@
    on for portable applications.
   </para>
  </refsect1>
+ 
+  <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the number of rows.
+  </para>
+ </refsect1>
+ 
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
diff --git a/reference/pdo/functions/PDOStatement-setAttribute.xml b/reference/pdo/functions/PDOStatement-setAttribute.xml
index 2e68a0a765..91c17f3f9f 100644
--- a/reference/pdo/functions/PDOStatement-setAttribute.xml
+++ b/reference/pdo/functions/PDOStatement-setAttribute.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
 <refentry id="function.PDOStatement-setAttribute">
  <refnamediv>
   <refname>PDOStatement->setAttribute()</refname>
@@ -30,104 +30,12 @@
 
  </refsect1>
 
- <!--
- <refsect1 role="parameters">
-  &reftitle.parameters;
-  <para>
-   <variablelist>
-    <varlistentry>
-     <term><parameter>attribute</parameter></term>
-      <listitem>
-       <para>
-        Its description
-       </para>
-      </listitem>
-     </varlistentry>
-    <varlistentry>
-     <term><parameter>value</parameter></term>
-      <listitem>
-       <para>
-        Its description
-       </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 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>Description of change
-      </row>
-     </tbody>
-    </tgroup>
-   </informaltable>
-  </para>
- </refsect1>
- -->
-
-
- <!-- Use when examples exist
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><function>A PDOStatement-setAttribute 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>
- -->
 
  <refsect1 role="seealso">
   &reftitle.seealso;