From 07fcabc3b30a09cafb7799818e5be5a53105bdc8 Mon Sep 17 00:00:00 2001
From: Damien Seguy <dams@php.net>
Date: Wed, 12 Feb 2003 17:57:03 +0000
Subject: [PATCH] Letter case update, proto correction

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@115952 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/oracle/functions/ora-columnname.xml |  8 ++++----
 reference/oracle/functions/ora-columnsize.xml |  6 +++---
 reference/oracle/functions/ora-columntype.xml | 10 +++++-----
 reference/oracle/functions/ora-commit.xml     | 14 +++++++-------
 reference/oracle/functions/ora-commitoff.xml  | 12 ++++++------
 reference/oracle/functions/ora-error.xml      |  6 +++---
 reference/oracle/functions/ora-errorcode.xml  |  6 +++---
 reference/oracle/functions/ora-exec.xml       | 14 +++++++++-----
 reference/oracle/functions/ora-fetch.xml      |  8 ++++----
 reference/oracle/functions/ora-getcolumn.xml  | 12 ++++++------
 reference/oracle/functions/ora-logoff.xml     | 12 ++++++------
 reference/oracle/functions/ora-logon.xml      | 10 +++++-----
 reference/oracle/functions/ora-numcols.xml    |  4 ++--
 reference/oracle/functions/ora-numrows.xml    |  4 ++--
 reference/oracle/functions/ora-open.xml       |  4 ++--
 reference/oracle/functions/ora-parse.xml      |  6 +++---
 reference/oracle/functions/ora-plogon.xml     |  6 +++---
 17 files changed, 73 insertions(+), 69 deletions(-)

diff --git a/reference/oracle/functions/ora-columnname.xml b/reference/oracle/functions/ora-columnname.xml
index 429adbb7b3..98200dc667 100644
--- a/reference/oracle/functions/ora-columnname.xml
+++ b/reference/oracle/functions/ora-columnname.xml
@@ -1,15 +1,15 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-columnname">
    <refnamediv>
-    <refname>Ora_ColumnName</refname>
-    <refpurpose>get name of Oracle result column</refpurpose>
+    <refname>ora_columnname</refname>
+    <refpurpose>Get name of Oracle result column</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>string</type><methodname>Ora_ColumnName</methodname>
+      <type>string</type><methodname>ora_columnname</methodname>
       <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
       <methodparam><type>int</type><parameter>column</parameter></methodparam>
      </methodsynopsis>
diff --git a/reference/oracle/functions/ora-columnsize.xml b/reference/oracle/functions/ora-columnsize.xml
index 66682a6b02..c7af50687a 100644
--- a/reference/oracle/functions/ora-columnsize.xml
+++ b/reference/oracle/functions/ora-columnsize.xml
@@ -1,15 +1,15 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.10 -->
   <refentry id="function.ora-columnsize">
    <refnamediv>
-    <refname>Ora_ColumnSize</refname>
+    <refname>ora_columnsize</refname>
     <refpurpose>get size of Oracle result column</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>Ora_ColumnSize</methodname>
+      <type>int</type><methodname>ora_columnsize</methodname>
       <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
       <methodparam><type>int</type><parameter>column</parameter></methodparam>
      </methodsynopsis>
diff --git a/reference/oracle/functions/ora-columntype.xml b/reference/oracle/functions/ora-columntype.xml
index 1e381b2e58..efa46e0a33 100644
--- a/reference/oracle/functions/ora-columntype.xml
+++ b/reference/oracle/functions/ora-columntype.xml
@@ -1,16 +1,16 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-columntype">
    <refnamediv>
-    <refname>Ora_ColumnType</refname>
-    <refpurpose>get type of Oracle result column</refpurpose>
+    <refname>ora_columntype</refname>
+    <refpurpose>Get type of Oracle result column</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>string</type><methodname>Ora_ColumnType</methodname>
-      <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
+      <type>string</type><methodname>ora_columntype</methodname>
+      <methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
       <methodparam><type>int</type><parameter>column</parameter></methodparam>
      </methodsynopsis>
     <para>
diff --git a/reference/oracle/functions/ora-commit.xml b/reference/oracle/functions/ora-commit.xml
index ec2431b9b4..e99ee9dffd 100644
--- a/reference/oracle/functions/ora-commit.xml
+++ b/reference/oracle/functions/ora-commit.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-commit">
    <refnamediv>
-    <refname>Ora_Commit</refname>
+    <refname>ora_commit</refname>
     <refpurpose>commit an Oracle transaction</refpurpose>
    </refnamediv>
    <refsect1>
@@ -12,16 +12,16 @@
       <type>int</type><methodname>ora_commit</methodname>
       <methodparam><type>int</type><parameter>conn</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     &return.success; Details about the
-     error can be retrieved using the <function>ora_error</function>
-     and <function>ora_errorcode</function> functions.
-    </para>
     <para>
      This function commits an Oracle transaction. A transaction is defined as
      all the changes on a given connection since the last commit/rollback,
      autocommit was turned off or when the connection was established.
     </para>
+    <para>
+     &return.success; Details about the
+     error can be retrieved using the <function>ora_error</function>
+     and <function>ora_errorcode</function> functions.
+    </para>
    </refsect1>
   </refentry>
 
diff --git a/reference/oracle/functions/ora-commitoff.xml b/reference/oracle/functions/ora-commitoff.xml
index 9352c946c9..2c0d0aa53b 100644
--- a/reference/oracle/functions/ora-commitoff.xml
+++ b/reference/oracle/functions/ora-commitoff.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-commitoff">
    <refnamediv>
-    <refname>Ora_CommitOff</refname>
+    <refname>ora_commitoff</refname>
     <refpurpose>disable automatic commit</refpurpose>
    </refnamediv>
    <refsect1>
@@ -12,15 +12,15 @@
       <type>int</type><methodname>ora_commitoff</methodname>
       <methodparam><type>int</type><parameter>conn</parameter></methodparam>
      </methodsynopsis>
+    <para>
+     This function turns off automatic commit after each
+     <function>ora_exec</function>.
+    </para>
     <para>
      &return.success; Details about the error
      can be retrieved using the <function>ora_error</function> and
      <function>ora_errorcode</function> functions.
     </para>
-    <para>
-     This function turns off automatic commit after each
-     <function>ora_exec</function>.
-    </para>
    </refsect1>
   </refentry>
 
diff --git a/reference/oracle/functions/ora-error.xml b/reference/oracle/functions/ora-error.xml
index 5f9d1c6e7b..177231cf0b 100644
--- a/reference/oracle/functions/ora-error.xml
+++ b/reference/oracle/functions/ora-error.xml
@@ -1,15 +1,15 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-error">
    <refnamediv>
-    <refname>Ora_Error</refname>
+    <refname>ora_error</refname>
     <refpurpose>get Oracle error message</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>string</type><methodname>Ora_Error</methodname>
+      <type>string</type><methodname>ora_error</methodname>
       <methodparam><type>int</type><parameter>cursor_or_connection</parameter></methodparam>
      </methodsynopsis>
     <para>
diff --git a/reference/oracle/functions/ora-errorcode.xml b/reference/oracle/functions/ora-errorcode.xml
index b5c4fc54bb..c859734ba7 100644
--- a/reference/oracle/functions/ora-errorcode.xml
+++ b/reference/oracle/functions/ora-errorcode.xml
@@ -1,15 +1,15 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-errorcode">
    <refnamediv>
-    <refname>Ora_ErrorCode</refname>
+    <refname>ora_errorcode</refname>
     <refpurpose>get Oracle error code</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>Ora_ErrorCode</methodname>
+      <type>int</type><methodname>ora_errorcode</methodname>
       <methodparam><type>int</type><parameter>cursor_or_connection</parameter></methodparam>
      </methodsynopsis>
     <para>
diff --git a/reference/oracle/functions/ora-exec.xml b/reference/oracle/functions/ora-exec.xml
index 820bcbaac2..fc57bc8797 100644
--- a/reference/oracle/functions/ora-exec.xml
+++ b/reference/oracle/functions/ora-exec.xml
@@ -1,17 +1,21 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-exec">
    <refnamediv>
-    <refname>Ora_Exec</refname>
-    <refpurpose>execute parsed statement on an Oracle cursor</refpurpose>
+    <refname>ora_exec</refname>
+    <refpurpose>Execute parsed statement on an Oracle cursor</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>ora_exec</methodname>
-      <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
+      <type>bool</type><methodname>ora_exec</methodname>
+      <methodparam><type>resource</type><parameter>cursor</parameter></methodparam>
      </methodsynopsis>
+    <para>
+     <function>ora_exec</function> execute the parsed statement 
+     <parameter>cursor</parameter>, already parsed by <function>ora_parse</function>.
+    </para>
     <para>
      &return.success; Details about the error
      can be retrieved using the <function>ora_error</function> and
diff --git a/reference/oracle/functions/ora-fetch.xml b/reference/oracle/functions/ora-fetch.xml
index 2655526538..f919480610 100644
--- a/reference/oracle/functions/ora-fetch.xml
+++ b/reference/oracle/functions/ora-fetch.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
   <refentry id="function.ora-fetch">
    <refnamediv>
@@ -12,6 +12,9 @@
       <type>int</type><methodname>ora_fetch</methodname>
       <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
      </methodsynopsis>
+    <para>
+     Retrieves a row of data from the specified <parameter>cursor</parameter>.
+    </para>
     <para>
      Returns &true; (a row was fetched) or &false; (no more rows, or an
      error occured). If an error occured, details can be retrieved
@@ -19,9 +22,6 @@
      <function>ora_errorcode</function> functions. If there was no
      error, <function>ora_errorcode</function> will return 0.
     </para>
-    <para>
-     Retrieves a row of data from the specified cursor.
-    </para>
     <simpara>
      See also <function>ora_parse</function>,<function>ora_exec</function>,
      and <function>ora_do</function>.
diff --git a/reference/oracle/functions/ora-getcolumn.xml b/reference/oracle/functions/ora-getcolumn.xml
index e62e9c4c93..c8dd09f59f 100644
--- a/reference/oracle/functions/ora-getcolumn.xml
+++ b/reference/oracle/functions/ora-getcolumn.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-getcolumn">
    <refnamediv>
-    <refname>Ora_GetColumn</refname>
-    <refpurpose>get data from a fetched column</refpurpose>
+    <refname>ora_getcolumn</refname>
+    <refpurpose>Get data from a fetched column</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -13,6 +13,9 @@
       <methodparam><type>int</type><parameter>cursor</parameter></methodparam>
       <methodparam><type>mixed</type><parameter>column</parameter></methodparam>
      </methodsynopsis>
+    <para>
+     Fetches the data for a column or function result.
+    </para>
     <para>
      Returns the column data. If an error occurs, &false; is returned
      and <function>ora_errorcode</function>
@@ -21,9 +24,6 @@
      not error as well (&null; result, empty string, the number 0, the
      string "0").
     </para>
-    <para>
-     Fetches the data for a column or function result.
-    </para>
    </refsect1>
   </refentry>
 
diff --git a/reference/oracle/functions/ora-logoff.xml b/reference/oracle/functions/ora-logoff.xml
index ce46b6ee8e..c4aa696c5d 100644
--- a/reference/oracle/functions/ora-logoff.xml
+++ b/reference/oracle/functions/ora-logoff.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-logoff">
    <refnamediv>
-    <refname>Ora_Logoff</refname>
-    <refpurpose>close an Oracle connection</refpurpose>
+    <refname>ora_logoff</refname>
+    <refpurpose>Close an Oracle connection</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
@@ -12,14 +12,14 @@
       <type>int</type><methodname>ora_logoff</methodname>
       <methodparam><type>int</type><parameter>connection</parameter></methodparam>
      </methodsynopsis>
+    <para>
+     Logs out the user and disconnects from the server.
+    </para>
     <para>
      &return.success; Details about the error
      can be retrieved using the <function>ora_error</function> and
      <function>ora_errorcode</function> functions.
     </para>
-    <para>
-     Logs out the user and disconnects from the server.
-    </para>
     <simpara>
      See also <function>ora_logon</function>.
     </simpara>
diff --git a/reference/oracle/functions/ora-logon.xml b/reference/oracle/functions/ora-logon.xml
index 517e4fca46..3c5c612242 100644
--- a/reference/oracle/functions/ora-logon.xml
+++ b/reference/oracle/functions/ora-logon.xml
@@ -1,21 +1,21 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
   <refentry id="function.ora-logon">
    <refnamediv>
-    <refname>Ora_Logon</refname>
-    <refpurpose>open an Oracle connection</refpurpose>
+    <refname>ora_logon</refname>
+    <refpurpose>Open an Oracle connection</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>ora_logon</methodname>
+      <type>resource</type><methodname>ora_logon</methodname>
       <methodparam><type>string</type><parameter>user</parameter></methodparam>
       <methodparam><type>string</type><parameter>password</parameter></methodparam>
      </methodsynopsis>
     <para>
      Establishes a connection between PHP and an Oracle database with the
-     given username and password.
+     given username <parameter>user</parameter> and password <parameter>password</parameter>.
     </para>
     <para>
      Connections can be made using <productname>SQL*Net</productname>
diff --git a/reference/oracle/functions/ora-numcols.xml b/reference/oracle/functions/ora-numcols.xml
index 2902eafef7..fdc7612a4a 100644
--- a/reference/oracle/functions/ora-numcols.xml
+++ b/reference/oracle/functions/ora-numcols.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
   <refentry id="function.ora-numcols">
    <refnamediv>
-    <refname>Ora_Numcols</refname>
+    <refname>ora_numcols</refname>
     <refpurpose>Returns the number of columns</refpurpose>
    </refnamediv>
    <refsect1>
diff --git a/reference/oracle/functions/ora-numrows.xml b/reference/oracle/functions/ora-numrows.xml
index 274e953e61..4579e8198c 100644
--- a/reference/oracle/functions/ora-numrows.xml
+++ b/reference/oracle/functions/ora-numrows.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.5 -->
   <refentry id="function.ora-numrows">
    <refnamediv>
-    <refname>Ora_Numrows</refname>
+    <refname>ora_numrows</refname>
     <refpurpose>Returns the number of rows</refpurpose>
    </refnamediv>
    <refsect1>
diff --git a/reference/oracle/functions/ora-open.xml b/reference/oracle/functions/ora-open.xml
index f1beffe64c..76887c4482 100644
--- a/reference/oracle/functions/ora-open.xml
+++ b/reference/oracle/functions/ora-open.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-open">
    <refnamediv>
-    <refname>Ora_Open</refname>
+    <refname>ora_open</refname>
     <refpurpose>open an Oracle cursor</refpurpose>
    </refnamediv>
    <refsect1>
diff --git a/reference/oracle/functions/ora-parse.xml b/reference/oracle/functions/ora-parse.xml
index 5c2451d5a7..69e7072af7 100644
--- a/reference/oracle/functions/ora-parse.xml
+++ b/reference/oracle/functions/ora-parse.xml
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-parse">
    <refnamediv>
-    <refname>Ora_Parse</refname>
-    <refpurpose>parse an SQL statement</refpurpose>
+    <refname>ora_parse</refname>
+    <refpurpose>Parse an SQL statement with Oracle</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
diff --git a/reference/oracle/functions/ora-plogon.xml b/reference/oracle/functions/ora-plogon.xml
index 10a5d445aa..226ce5f635 100644
--- a/reference/oracle/functions/ora-plogon.xml
+++ b/reference/oracle/functions/ora-plogon.xml
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/oracle.xml, last change in rev 1.2 -->
   <refentry id="function.ora-plogon">
    <refnamediv>
-    <refname>Ora_pLogon</refname>
+    <refname>ora_plogon</refname>
     <refpurpose>
      Open a persistent Oracle connection
     </refpurpose>
@@ -17,7 +17,7 @@
      </methodsynopsis>
     <para>
      Establishes a persistent connection between PHP and an Oracle database with
-     the given username and password.
+     the username <parameter>user</parameter> and password <parameter>password</parameter>. 
     </para>
     <simpara>
      See also <function>ora_logon</function>.