updating protos

adding some tags
less redundancy


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@137471 c90b9560-bf6c-de11-be94-00142212c4b1

reference/ovrimos/functions/ovrimos-close.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-close">
    <refnamediv>
@@ -14,11 +14,7 @@
      </methodsynopsis>
     <para>
      <function>ovrimos_close</function> is used to close the specified
-     connection.
-    </para>
-    <para>
-     <function>ovrimos_close</function> closes a connection to
-     Ovrimos. This has the effect of rolling back uncommitted
+     connection to Ovrimos. This has the effect of rolling back uncommitted
      transactions.
     </para>
    </refsect1>

reference/ovrimos/functions/ovrimos-commit.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-commit">
    <refnamediv>
@@ -9,15 +9,12 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>ovrimos_commit</methodname>
+      <type>bool</type><methodname>ovrimos_commit</methodname>
       <methodparam><type>int</type><parameter>connection_id</parameter></methodparam>
      </methodsynopsis>
     <para>
      <function>ovrimos_commit</function> is used to commit the
-     transaction.
-    </para>
-    <para>
-     <function>ovrimos_commit</function> commits the transaction.
+     transaction. &return.success;
     </para>
     </refsect1>
   </refentry>

reference/ovrimos/functions/ovrimos-connect.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-connect">
    <refnamediv>
@@ -21,10 +21,11 @@
     </para>
     <para>
      <function>ovrimos_connect</function> returns a connection id
-     (greater than 0) or 0 for failure. The meaning of 'host' and
-     'port' are those used everywhere in Ovrimos APIs. 'Host' is a
-     host name or IP address and 'db' is either a database name, or a
-     string containing the port number.
+     (greater than 0) or 0 for failure. The meaning of 
+     <parameter>host</parameter> and <parameter>db</parameter> are
+     those used everywhere in Ovrimos APIs. <parameter>host</parameter>
+     is a host name or IP address and <parameter>db</parameter> is either
+     a database name, or a string containing the port number.
     </para>
     <para>
      <example>

reference/ovrimos/functions/ovrimos-cursor.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-cursor">
    <refnamediv>
@@ -9,13 +9,9 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>ovrimos_cursor</methodname>
+      <type>string</type><methodname>ovrimos_cursor</methodname>
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_cursor</function> is used to get the name of
-     the cursor.
-    </para>
     <para>
      <function>ovrimos_cursor</function> returns the name of the
      cursor. Useful when wishing to perform positioned updates or

reference/ovrimos/functions/ovrimos-exec.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-exec">
    <refnamediv>
@@ -13,10 +13,6 @@
       <methodparam><type>int</type><parameter>connection_id</parameter></methodparam>
       <methodparam><type>string</type><parameter>query</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_exec</function> is used to execute an SQL
-     statement.
-    </para>
     <para>
      <function>ovrimos_exec</function> executes an SQL statement
      (query or update) and returns a result_id or &false;.  Evidently,

reference/ovrimos/functions/ovrimos-execute.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-execute">
    <refnamediv>
@@ -13,13 +13,9 @@
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
       <methodparam choice="opt"><type>array</type><parameter>parameters_array</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_execute</function> is used to execute an SQL
-     statement.
-    </para>
     <para>
      <function>ovrimos_execute</function> executes a prepared
-     statement. Returns &true; or &false;.
+     statement. &return.success;
      If the prepared statement
      contained parameters (question marks in the statement), the
      correct number of parameters should be passed in an array. Notice
@@ -27,7 +23,7 @@
      of the optional parameter inside square brackets. I couldn't
      bring myself on liking it.
     </para>
-    </refsect1>
+   </refsect1>
   </refentry>
 
 <!-- Keep this comment at the end of the file

reference/ovrimos/functions/ovrimos-fetch-into.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-fetch-into">
    <refnamediv>
@@ -15,22 +15,20 @@
       <methodparam choice="opt"><type>string</type><parameter>how</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>rownumber</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_fetch_into</function> is used to fetch a row
-     from the result set.
-    </para>
     <para>
      <function>ovrimos_fetch_into</function> fetches a row from the
-     result set into 'result_array', which should be passed by
-     reference. Which row is fetched is determined by the two last
-     parameters.  'how' is one of 'Next' (default), 'Prev', 'First',
-     'Last', 'Absolute', corresponding to forward direction from
+     result set into <parameter>result_array</parameter>, which should
+     be passed by reference. Which row is fetched is determined by the
+     two last parameters. <parameter>how</parameter> is one of 
+     <literal>Next</literal> (default), <literal>Prev</literal>, 
+     <literal>First</literal>, <literal>Last</literal>, 
+     <literal>Absolute</literal>, corresponding to forward direction from
      current position, backward direction from current position,
      forward direction from the start, backward direction from the end
      and absolute position from the start (essentially equivalent to
      'first' but needs 'rownumber'). Case is not
-     significant. 'Rownumber' is optional except for absolute
-     positioning. Returns &true; or &false;.
+     significant. <parameter>rownumber</parameter> is optional except for
+     absolute positioning. &return.success;
     </para>
     <para>
      <example>

reference/ovrimos/functions/ovrimos-fetch-row.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-fetch-row">
    <refnamediv>
@@ -14,14 +14,10 @@
       <methodparam choice="opt"><type>int</type><parameter>how</parameter></methodparam>
       <methodparam choice="opt"><type>int</type><parameter>row_number</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_fetch_row</function> is used to fetch a row
-     from the result set.
-    </para>
     <para>
      <function>ovrimos_fetch_row</function> fetches a row from the
      result set. Column values should be retrieved with other
-     calls. Returns &true; or &false;.
+     calls. &return.success;
     </para>
     <para>
      <example>

reference/ovrimos/functions/ovrimos-field-len.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-field-len">
    <refnamediv>
@@ -15,14 +15,10 @@
      </methodsynopsis>
     <para>
      <function>ovrimos_field_len</function> is used to get the length
-     of the output column with number <parameter>field_number</parameter>,
-     in result <parameter>result_id</parameter>.
+     of the output column with number <parameter>field_number</parameter>
+     (1-based), in result <parameter>result_id</parameter>.
     </para>
-    <para>
-     <function>ovrimos_field_len</function> returns the length of the
-     output column at the (1-based) index specified.
-    </para>
-    </refsect1>
+   </refsect1>
   </refentry>
 
 <!-- Keep this comment at the end of the file

reference/ovrimos/functions/ovrimos-field-name.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-field-name">
    <refnamediv>
@@ -9,14 +9,10 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>ovrimos_field_name</methodname>
+      <type>string</type><methodname>ovrimos_field_name</methodname>
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
       <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_field_name</function> is used to get the output
-     column name.
-    </para>
     <para>
      <function>ovrimos_field_name</function> returns the output column
      name at the (1-based) index specified.

reference/ovrimos/functions/ovrimos-field-num.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-field-num">
    <refnamediv>
@@ -15,13 +15,10 @@
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
       <methodparam><type>string</type><parameter>field_name</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_field_num</function> is used to get the
-     (1-based) index of the output column.
-    </para>
     <para>
      <function>ovrimos_field_num</function> returns the (1-based)
-     index of the output column specified by name, or &false;.
+     index of the output column specified by <parameter>field_name</parameter>,
+     or &false;.
     </para>
    </refsect1>
   </refentry>

reference/ovrimos/functions/ovrimos-field-type.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-field-type">
    <refnamediv>
@@ -15,13 +15,10 @@
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
       <methodparam><type>int</type><parameter>field_number</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_field_type</function> is used to get the
-     (numeric) type of the output column.
-    </para>
     <para>
      <function>ovrimos_field_type</function> returns the (numeric)
-     type of the output column at the (1-based) index specified.
+     type of the output column at the (1-based) index specified by
+     <parameter>field_number</parameter>.
     </para>
     </refsect1>
   </refentry>

reference/ovrimos/functions/ovrimos-free-result.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-free-result">
    <refnamediv>
@@ -12,13 +12,9 @@
       <type>bool</type><methodname>ovrimos_free_result</methodname>
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_free_result</function> is used to free the
-     result_id.
-    </para>
     <para>
      <function>ovrimos_free_result</function> frees the specified
-     result_id <parameter>result_id</parameter>. Returns &true;.
+     <parameter>result_id</parameter>. Returns &true;.
     </para>
     </refsect1>
   </refentry>

reference/ovrimos/functions/ovrimos-longreadlen.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-longreadlen">
    <refnamediv>
@@ -11,14 +11,10 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>ovrimos_longreadlen</methodname>
+      <type>bool</type><methodname>ovrimos_longreadlen</methodname>
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
       <methodparam><type>int</type><parameter>length</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_longreadlen</function> is used to specify how
-     many bytes are to be retrieved from long datatypes.
-    </para>
     <para>
      <function>ovrimos_longreadlen</function> specifies how many bytes
      are to be retrieved from long datatypes (long varchar and long

reference/ovrimos/functions/ovrimos-num-fields.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-num-fields">
    <refnamediv>
@@ -12,13 +12,9 @@
       <type>int</type><methodname>ovrimos_num_fields</methodname>
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_num_fields</function> is used to get the number
-     of columns.
-    </para>
     <para>
      <function>ovrimos_num_fields</function> returns the number of
-     columns in a result_id resulting from a query.
+     columns in a <parameter>result_id</parameter> resulting from a query.
     </para>
    </refsect1>
   </refentry>

reference/ovrimos/functions/ovrimos-num-rows.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-num-rows">
    <refnamediv>
@@ -14,10 +14,6 @@
       <type>int</type><methodname>ovrimos_num_rows</methodname>
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_num_rows</function> is used to get the number
-     of rows affected by update operations.
-    </para>
     <para>
      <function>ovrimos_num_rows</function> returns the number of rows
      affected by update operations.

reference/ovrimos/functions/ovrimos-prepare.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-prepare">
    <refnamediv>
@@ -13,9 +13,6 @@
       <methodparam><type>int</type><parameter>connection_id</parameter></methodparam>
       <methodparam><type>string</type><parameter>query</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_prepare</function> is used to prepare an SQL statement.
-    </para>
     <para>
      <function>ovrimos_prepare</function> prepares an SQL statement
      and returns a result_id (or &false; on failure).

reference/ovrimos/functions/ovrimos-result-all.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-result-all">
    <refnamediv>
@@ -11,18 +11,14 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>bool</type><methodname>ovrimos_result_all</methodname>
+      <type>int</type><methodname>ovrimos_result_all</methodname>
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
       <methodparam choice="opt"><type>string</type><parameter>format</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_result_all</function> is used to print an HTML
-     table containing the whole result set.
-    </para>
     <para>
      <function>ovrimos_result_all</function> prints the whole result
-     set as an HTML table. Returns &true; or 
-     &false;.
+     set as an HTML table. Returns the number of rows in the generated
+     table.
     </para>
     <para>
      <example>
@@ -58,7 +54,7 @@ if ($conn != 0) {
     </para>
     <para>
      <example>
-      <title>Ovrimos_result_all with meta-information</title>
+      <title><function>ovrimos_result_all</function> with meta-information</title>
       <programlisting role="php">
 <![CDATA[
 <?php
@@ -89,7 +85,7 @@ if ($conn != 0) {
     </para>
     <para>
      <example>
-      <title>ovrimos_result_all example</title>
+      <title><function>ovrimos_result_all</function> example</title>
       <programlisting role="php">
 <![CDATA[
 <?php

reference/ovrimos/functions/ovrimos-result.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-result">
    <refnamediv>
@@ -9,17 +9,14 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>ovrimos_result</methodname>
+      <type>string</type><methodname>ovrimos_result</methodname>
       <methodparam><type>int</type><parameter>result_id</parameter></methodparam>
       <methodparam><type>mixed</type><parameter>field</parameter></methodparam>
      </methodsynopsis>
-    <para>
-     <function>ovrimos_result</function> is used to retrieve the
-     output column.
-    </para>
     <para>
      <function>ovrimos_result</function> retrieves the output column
-     specified by 'field', either as a string or as an 1-based index.
+     specified by <parameter>field</parameter>, either as a string or
+     as an 1-based index. Returns &false; on failure.
     </para>
     </refsect1>
   </refentry>

reference/ovrimos/functions/ovrimos-rollback.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/ovrimos.xml, last change in rev 1.1 -->
   <refentry id="function.ovrimos-rollback">
    <refnamediv>
@@ -9,15 +9,12 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>ovrimos_rollback</methodname>
+      <type>bool</type><methodname>ovrimos_rollback</methodname>
       <methodparam><type>int</type><parameter>connection_id</parameter></methodparam>
      </methodsynopsis>
     <para>
      <function>ovrimos_rollback</function> is used to roll back the
-     transaction.
-    </para>
-    <para>
-     <function>ovrimos_rollback</function> rolls back the transaction.
+     transaction. &return.succes;
     </para>
     </refsect1>
   </refentry>