From 5a22075d9563ce3044a974d14a21d60f7549cb96 Mon Sep 17 00:00:00 2001
From: Esen Sagynov <cubrid@php.net>
Date: Mon, 13 Feb 2012 04:51:47 +0000
Subject: [PATCH] [APIS-99] Update PHP API documentation on php.net

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@323169 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/cubrid/cubridmysql/cubrid-data-seek.xml       | 8 +-------
 reference/cubrid/cubridmysql/cubrid-error.xml           | 2 +-
 reference/cubrid/cubridmysql/cubrid-list-dbs.xml        | 2 +-
 reference/cubrid/cubridmysql/cubrid-num-fields.xml      | 7 ++++++-
 reference/cubrid/functions/cubrid-connect.xml           | 5 +++--
 reference/cubrid/functions/cubrid-move-cursor.xml       | 9 +++------
 reference/cubrid/functions/cubrid-num-cols.xml          | 4 ++--
 reference/cubrid/functions/cubrid-num-rows.xml          | 7 ++++++-
 reference/cubrid/functions/cubrid-pconnect-with-url.xml | 8 ++++----
 9 files changed, 27 insertions(+), 25 deletions(-)

diff --git a/reference/cubrid/cubridmysql/cubrid-data-seek.xml b/reference/cubrid/cubridmysql/cubrid-data-seek.xml
index 9d9cb5a18a..cdcb5da641 100644
--- a/reference/cubrid/cubridmysql/cubrid-data-seek.xml
+++ b/reference/cubrid/cubridmysql/cubrid-data-seek.xml
@@ -42,13 +42,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-    CUBRID_CURSOR_SUCCESS, on success.
-  </para>
-  <para>
-    CUBRID_NO_MORE_DATA, when it is not a valid cursor location.
-  </para>
-  <para>
-    &false; on CAS error, row count is 0, or invalid offset.
+   Returns &true; on success or &false; on failure.
   </para>
  </refsect1>
 
diff --git a/reference/cubrid/cubridmysql/cubrid-error.xml b/reference/cubrid/cubridmysql/cubrid-error.xml
index 8126900804..76767dc944 100644
--- a/reference/cubrid/cubridmysql/cubrid-error.xml
+++ b/reference/cubrid/cubridmysql/cubrid-error.xml
@@ -26,7 +26,7 @@
   <variablelist>
     <varlistentry>
      <term><parameter>connection</parameter></term>
-     <listitem><para></para></listitem>
+     <listitem><para>The CUBRID connection.</para></listitem>
    </varlistentry>
   </variablelist>
   </para>
diff --git a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml b/reference/cubrid/cubridmysql/cubrid-list-dbs.xml
index e497d5bcd6..dd6fa8e78d 100644
--- a/reference/cubrid/cubridmysql/cubrid-list-dbs.xml
+++ b/reference/cubrid/cubridmysql/cubrid-list-dbs.xml
@@ -11,7 +11,7 @@
   &reftitle.description;
   <methodsynopsis>
    <type>array</type><methodname>cubrid_list_dbs</methodname>
-   <methodparam><type>resource</type><parameter>conn_identifier</parameter></methodparam>  
+   <methodparam choice="opt"><type>resource</type><parameter>conn_identifier</parameter></methodparam>  
   </methodsynopsis>
   <para>
    This function returns an array with the list of all existing Cubrid
diff --git a/reference/cubrid/cubridmysql/cubrid-num-fields.xml b/reference/cubrid/cubridmysql/cubrid-num-fields.xml
index c15c4f1c58..94c6d48add 100644
--- a/reference/cubrid/cubridmysql/cubrid-num-fields.xml
+++ b/reference/cubrid/cubridmysql/cubrid-num-fields.xml
@@ -25,7 +25,9 @@
   <variablelist>
     <varlistentry>
     <term><parameter>result</parameter></term>
-    <listitem><para><parameter>result</parameter> comes from a call to <function>cubrid_execute</function></para></listitem>
+    <listitem><para><parameter>result</parameter> comes from a call to
+      <function>cubrid_execute</function>, <function>cubrid_query</function>
+      and <function>cubrid_prepare</function></para></listitem>
    </varlistentry>
   </variablelist>
   </para>
@@ -39,6 +41,9 @@
    <para>
     -1 if SQL sentence is not SELECT.
   </para>
+  <para>
+   &false; when process is unsuccessful.
+  </para>
  </refsect1>
 
  <refsect1 role="examples">
diff --git a/reference/cubrid/functions/cubrid-connect.xml b/reference/cubrid/functions/cubrid-connect.xml
index 454fdae2bc..fffd360af3 100644
--- a/reference/cubrid/functions/cubrid-connect.xml
+++ b/reference/cubrid/functions/cubrid-connect.xml
@@ -45,11 +45,12 @@
    </varlistentry>
    <varlistentry>
     <term><parameter>userid</parameter></term>
-    <listitem><para>User name for the database.</para></listitem>
+    <listitem><para>User name for the database. If not given, the default
+      value is "public".</para></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>passwd</parameter></term>
-    <listitem><para>User password.</para></listitem>
+    <listitem><para>User password. If not given, the default value is "".</para></listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>new_link</parameter></term>
diff --git a/reference/cubrid/functions/cubrid-move-cursor.xml b/reference/cubrid/functions/cubrid-move-cursor.xml
index 0e4c850e2d..f418fbd4cb 100644
--- a/reference/cubrid/functions/cubrid-move-cursor.xml
+++ b/reference/cubrid/functions/cubrid-move-cursor.xml
@@ -58,13 +58,10 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-    CUBRID_CURSOR_SUCCESS, when process is successful.
+   &true;, when process is successful.
   </para>
-    <para>
-    CUBRID_NO_MORE_DATA, when it is not a valid cursor location.
-  </para>
-    <para>
-    CUBRID_CURSOR_ERROR, in case of error.
+  <para>
+   &false;, when process is unsucceful.
   </para>
  </refsect1>
 
diff --git a/reference/cubrid/functions/cubrid-num-cols.xml b/reference/cubrid/functions/cubrid-num-cols.xml
index 3857d79a7a..901f4cc168 100644
--- a/reference/cubrid/functions/cubrid-num-cols.xml
+++ b/reference/cubrid/functions/cubrid-num-cols.xml
@@ -37,8 +37,8 @@
   <para>
     Number of columns, when process is successful.
   </para>
-    <para>
-    -1, if SQL statement is not SELECT.
+  <para>
+    &false;, if SQL statement is not SELECT.
   </para>
  </refsect1>
 
diff --git a/reference/cubrid/functions/cubrid-num-rows.xml b/reference/cubrid/functions/cubrid-num-rows.xml
index 6dae63e8f9..c19d35f4bc 100644
--- a/reference/cubrid/functions/cubrid-num-rows.xml
+++ b/reference/cubrid/functions/cubrid-num-rows.xml
@@ -32,7 +32,9 @@
   <variablelist>
     <varlistentry>
   <term><parameter>result</parameter></term>
-  <listitem><para>Result.</para></listitem>
+  <listitem><para><parameter>result</parameter> comes from a call to
+    <function>cubrid_execute</function>, <function>cubrid_query</function> and
+    <function>cubrid_prepare</function></para></listitem>
    </varlistentry>
   </variablelist>
   </para>
@@ -49,6 +51,9 @@
   <para>
     -1, if SQL statement is not SELECT.
   </para>
+  <para>
+   &false; when process is unsuccessful.
+  </para>
  </refsect1>
 
  <refsect1 role="examples">
diff --git a/reference/cubrid/functions/cubrid-pconnect-with-url.xml b/reference/cubrid/functions/cubrid-pconnect-with-url.xml
index d871230bc9..0663dbb4cd 100644
--- a/reference/cubrid/functions/cubrid-pconnect-with-url.xml
+++ b/reference/cubrid/functions/cubrid-pconnect-with-url.xml
@@ -76,7 +76,7 @@
    </para>
    <para>
     $url = "CUBRID:localhost:33000:tbd:::?autocommit=off";
-    $conn = cubrid_connect_with_url ($url, "dba", "12?");
+    $conn = cubrid_pconnect_with_url ($url, "dba", "12?");
    </para>
   </note>
  </refsect1>
@@ -114,7 +114,7 @@
  <refsect1 role="examples">
   &reftitle.examples;
   <example>
-   <title><function>cubrid_connect_with_url</function> url without properties example</title>
+   <title><function>cubrid_pconnect_with_url</function> url without properties example</title>
    <programlisting role="php">
 <![CDATA[
 <?php
@@ -139,12 +139,12 @@ if ($con) {
   </example>
   
   <example>
-   <title><function>cubrid_connect_with_url</function> url with properties example</title>
+   <title><function>cubrid_pconnect_with_url</function> url with properties example</title>
    <programlisting role="php">
 <![CDATA[
 <?php
 $conn_url = "CUBRID:127.0.0.1:33000:demodb:dba:123456:?autocommit=off&althost=10.34.63.132:33088&rctime=100"
-$con = cubrid_connect_with_url ($conn_url);
+$con = cubrid_pconnect_with_url ($conn_url);
 
 if ($con) {
    echo "connected successfully";