cvs: phpdoc /en/reference/mysqli/functions mysqli-fetch-field-direct.xml mysqli-fetch.xml mysqli-field-seek.xml mysqli-field-tell.xml
mysqli-master-query.xml mysqli-num-fields.xml mysqli-num-rows.xml mysqli-ping.xml mysqli-prepare.xml mysqli-real-escape-string.xml
mysqli-slave-query.xml mysqli-stat.xml mysqli-thread-safe.xml mysqli-warning-count.xml

philip Sat May 24 02:44:21 2003 EDT Modified files: /phpdoc/en/reference/mysqli/functions mysqli-warning-count.xml mysqli-thread-safe.xml mysqli-stat.xml mysqli-slave-query.xml mysqli-real-escape-string.xml mysqli-prepare.xml mysqli-ping.xml mysqli-num-rows.xml mysqli-num-fields.xml mysqli-master-query.xml mysqli-field-tell.xml mysqli-field-seek.xml mysqli-fetch.xml mysqli-fetch-field-direct.xml Log: Added refpurpose, and removed unneeded para around &warn.undocumented.func;

Index: phpdoc/en/reference/mysqli/functions/mysqli-warning-count.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-warning-count.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-warning-count.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-warning-count.xml:1.1 Sat Mar 15 18:01:35 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-warning-count.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-warning-count"> <refnamediv> <refname>mysqli_warning_count</refname> - <refpurpose></refpurpose> + <refpurpose> + Return the number of warnings from the last query for the given link + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -11,9 +13,9 @@ <type>resource</type><methodname>mysqli_warning_count</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-thread-safe.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-thread-safe.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-thread-safe.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-thread-safe.xml:1.1 Sat Mar 15 18:01:35 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-thread-safe.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-thread-safe"> <refnamediv> <refname>mysqli_thread_safe</refname> - <refpurpose></refpurpose> + <refpurpose> + Returns whether thread safety is given or not + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -11,9 +13,9 @@ <type>bool</type><methodname>mysqli_thread_safe</methodname> <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-stat.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-stat.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-stat.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-stat.xml:1.1 Sat Mar 15 18:01:35 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-stat.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-stat"> <refnamediv> <refname>mysqli_stat</refname> - <refpurpose></refpurpose> + <refpurpose> + Gets the current system status + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -11,9 +13,9 @@ <type>string</type><methodname>mysqli_stat</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-slave-query.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-slave-query.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-slave-query.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-slave-query.xml:1.1 Sat Mar 15 18:01:35 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-slave-query.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-slave-query"> <refnamediv> <refname>mysqli_slave_query</refname> - <refpurpose></refpurpose> + <refpurpose> + Enforces execution of a query on a slave in a master/slave setup + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,9 +14,9 @@ <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-real-escape-string.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-real-escape-string.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-real-escape-string.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-real-escape-string.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-real-escape-string.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-real-escape-string"> <refnamediv> <refname>mysqli_real_escape_string</refname> - <refpurpose>close statement</refpurpose> + <refpurpose> + Escapes special characters in a string for use in a SQL statement, + taking into account the current charset of the connection + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,9 +15,9 @@ <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>string</type><parameter>escapestr</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-prepare.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-prepare.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-prepare.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-prepare.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-prepare.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-prepare"> <refnamediv> <refname>mysqli_prepare</refname> - <refpurpose></refpurpose> + <refpurpose> + Prepare a SQL statement for execution + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,9 +14,9 @@ <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-ping.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-ping.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-ping.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-ping.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-ping.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-ping"> <refnamediv> <refname>mysqli_ping</refname> - <refpurpose></refpurpose> + <refpurpose> + Ping a server connection, or reconnect if there is no connection + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -11,9 +13,9 @@ <type>int</type><methodname>mysqli_ping</methodname> <methodparam><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-num-rows.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-num-rows.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-num-rows.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-num-rows.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-num-rows.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-num-rows"> <refnamediv> <refname>mysqli_num_rows</refname> - <refpurpose></refpurpose> + <refpurpose> + Get the number of rows in a result + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -11,9 +13,9 @@ <type>int</type><methodname>mysqli_num_rows</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-num-fields.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-num-fields.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-num-fields.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-num-fields.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-num-fields.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-num-fields"> <refnamediv> <refname>mysqli_num_fields</refname> - <refpurpose></refpurpose> + <refpurpose> + Get the number of fields in a result + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -11,9 +13,9 @@ <type>int</type><methodname>mysqli_num_fields</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-master-query.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-master-query.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-master-query.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-master-query.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-master-query.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-master-query"> <refnamediv> <refname>mysqli_master_query</refname> - <refpurpose></refpurpose> + <refpurpose> + Enforce execution of a query on the master in a master/slave setup + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,9 +14,9 @@ <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-field-tell.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-field-tell.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-field-tell.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-field-tell.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-field-tell.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-field-tell"> <refnamediv> <refname>mysqli_field_tell</refname> - <refpurpose></refpurpose> + <refpurpose> + Get current field offset of a result pointer + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -11,9 +13,9 @@ <type>int</type><methodname>mysqli_field_tell</methodname> <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-field-seek.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-field-seek.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-field-seek.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-field-seek.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-field-seek.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-field-seek"> <refnamediv> <refname>mysqli_field_seek</refname> - <refpurpose></refpurpose> + <refpurpose> + Set result pointer to a specified field offset + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,9 +14,9 @@ <methodparam><type>resource</type><parameter>link</parameter></methodparam> <methodparam><type>int</type><parameter>fieldnr</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-fetch.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-fetch.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-fetch.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-fetch.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-fetch.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-fetch"> <refnamediv> <refname>mysqli_fetch</refname> - <refpurpose></refpurpose> + <refpurpose> + Fetch results from a prepared statement into the bound variables + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -11,9 +13,9 @@ <type>int</type><methodname>mysqli_fetch</methodname> <methodparam><type>resource</type><parameter>stmt</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-fetch-field-direct.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-fetch-field-direct.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-fetch-field-direct.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-fetch-field-direct.xml:1.1 Fri Apr 25 18:01:11 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-fetch-field-direct.xml Sat May 24 02:44:21 2003 @@ -1,9 +1,11 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-fetch-field-direct"> <refnamediv> <refname>mysqli_fetch_field_direct</refname> - <refpurpose></refpurpose> + <refpurpose> + Fetch meta-data for a single field + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,9 +14,9 @@ <methodparam><type>resource</type><parameter>result</parameter></methodparam> <methodparam><type>int</type><parameter>offset</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + + &warn.undocumented.func; + </refsect1> </refentry>