cvs: phpdoc /en/reference/mysqli/functions mysqli-autocommit.xml mysqli-change-user.xml mysqli-close.xml mysqli-connect.xml mysqli-data-seek.xml
mysqli-errno.xml mysqli-error.xml mysqli-free-result.xml mysqli-get-client-info.xml mysqli-get-host-info.xml mysqli-get-proto-info.xml
mysqli-get-server-info.xml mysqli-get-server-version.xml mysqli-insert-id.xml mysqli-kill.xml mysqli-real-connect.xml

didou Fri May 23 14:07:24 2003 EDT Modified files: /phpdoc/en/reference/mysqli/functions mysqli-autocommit.xml mysqli-change-user.xml mysqli-close.xml mysqli-connect.xml mysqli-data-seek.xml mysqli-errno.xml mysqli-error.xml mysqli-free-result.xml mysqli-get-client-info.xml mysqli-get-host-info.xml mysqli-get-proto-info.xml mysqli-get-server-info.xml mysqli-get-server-version.xml mysqli-insert-id.xml mysqli-kill.xml mysqli-real-connect.xml Log: typos, entities and see also

Index: phpdoc/en/reference/mysqli/functions/mysqli-autocommit.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-autocommit.xml:1.3 phpdoc/en/reference/mysqli/functions/mysqli-autocommit.xml:1.4 --- phpdoc/en/reference/mysqli/functions/mysqli-autocommit.xml:1.3 Sat May 17 10:31:04 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-autocommit.xml Fri May 23 14:07:23 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.mysqli-autocommit"> <refnamediv> <refname>mysqli_autocommit</refname> - <refpurpose>Turns on and off auto-commiting database modifications</refpurpose> + <refpurpose>Turns on or off auto-commiting database modifications</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -15,8 +15,10 @@ <para> <function>mysqli_autocommit</function> is used to turn on or off auto-commit mode on queries for the database connection represented by the <parameter>link</parameter> - resource. The <function>mysqli_autocommit</function> will return a boolean indicating - success or failure of the call. + resource. + </para> + <para> + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-change-user.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-change-user.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-change-user.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-change-user.xml:1.2 Tue May 13 19:12:15 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-change-user.xml Fri May 23 14:07:23 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-change-user"> <refnamediv> <refname>mysqli_change_user</refname> @@ -18,11 +18,12 @@ <function>mysqli_change_user</function> is used to change the user of the specified database connection as given by the <parameter>link</parameter> parameter and sets the current database to that specified by the <parameter>database</parameter> parameter. - This function will return a boolean value indicating if the operation was successful - or not. </para> <para> - If desired, the NULL value may be passed in place of the <parameter>database</parameter> + &return.success; + </para> + <para> + If desired, the &null; value may be passed in place of the <parameter>database</parameter> parameter resulting in only changing the user and not selecting a database. To select a database in this case use the <function>mysqli_select_db</function> function. </para> Index: phpdoc/en/reference/mysqli/functions/mysqli-close.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-close.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-close.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-close.xml:1.2 Tue May 13 19:12:16 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-close.xml Fri May 23 14:07:23 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-close"> <refnamediv> <refname>mysqli_close</refname> @@ -14,6 +14,11 @@ <para> The <function>mysqli_close</function> function closes a previously opened database connection specified by the <parameter>link</parameter> parameter. + </para> + <para> + See also + <function>mysqli_connect</function> and + <function>mysqli_real_connect</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-connect.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-connect.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-connect.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-connect.xml:1.2 Tue May 13 19:12:16 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-connect.xml Fri May 23 14:07:23 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-connect"> <refnamediv> <refname>mysqli_connect</refname> @@ -17,16 +17,16 @@ <methodparam choice='opt'><type>string</type><parameter>socket</parameter></methodparam> </methodsynopsis> <para> - The <function>mysqli_connect</function> attempts to open a connection to the MySQL Server running - on <parameter>host</parameter> which can be either a hostname or an IP address. Passing the NULL - value or the string "localhost" to this parameter, the local host is assumed. When possible, pipes - will be used instead of the TCP/IP protocol. If successful, the <function>mysqli_connect</function> - will return a resource representing the connection to the database, or FALSE on failure. + The <function>mysqli_connect</function> function attempts to open a connection to the MySQL Server + running on <parameter>host</parameter> which can be either a hostname or an IP address. Passing the + &null; value or the string "localhost" to this parameter, the local host is assumed. When possible, + pipes will be used instead of the TCP/IP protocol. If successful, the <function>mysqli_connect</function> + will return a resource representing the connection to the database, or &false; on failure. </para> <para> The <parameter>username</parameter> and <parameter>password</parameter> parameters specify the username and password under which to connect to the MySQL server. If the password is not provided - (the NULL value is passed), the MySQL server will attempt to authenticate the user against those + (the &null; value is passed), the MySQL server will attempt to authenticate the user against those user records which have no password only. This allows one username to be used with different permissions (depending on if a password as provided or not). </para> @@ -48,6 +48,11 @@ MySQL database is determined by the <parameter>host</parameter> parameter. </para> </note> + <para> + See also + <function>mysqli_close</function> and + <function>mysqli_real_connect</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-data-seek.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-data-seek.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-data-seek.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-data-seek.xml:1.2 Tue May 13 19:12:16 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-data-seek.xml Fri May 23 14:07:23 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-data-seek"> <refnamediv> <refname>mysqli_data_seek</refname> @@ -16,7 +16,7 @@ The <function>mysqli_data_seek</function> function seeks to an arbitrary result pointer specified by the <parameter>offset</parameter> in the result set represented by <parameter>result</parameter>. The <parameter>offset</parameter> parameter must be between - zero and the total number of rows minus one (<function>0..mysqli_num_rows</function> - 1). + zero and the total number of rows minus one (0..<function>mysqli_num_rows</function> - 1). </para> <note> <para> @@ -24,6 +24,11 @@ <function>mysqli_store_result</function> function. </para> </note> + <para> + See also + <function>mysqli_store_result</function> and + <function>mysqli_num_rows</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-errno.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-errno.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-errno.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-errno.xml:1.2 Tue May 13 19:12:16 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-errno.xml Fri May 23 14:07:23 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-errno"> <refnamediv> <refname>mysqli_errno</refname> @@ -23,6 +23,10 @@ section of the MySQLi documentation </para> </note> + <para> + See also + <function>mysqli_error</function>. + </para> </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-error.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-error.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-error.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-error.xml:1.2 Tue May 13 19:12:16 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-error.xml Fri May 23 14:07:23 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-error"> <refnamediv> <refname>mysqli_error</refname> @@ -12,12 +12,16 @@ <methodparam><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> - The <function>mysqli_error</function> is identical to the corresponding + The <function>mysqli_error</function> function is identical to the corresponding <function>mysqli_errno</function> function in every way, except instead of returning an integer error code the <function>mysqli_error</function> function will return a string representation of the last error to occur for the database connection represented by the <parameter>link</parameter> parameter. If no error has occured, this function will return an empty string. + </para> + <para> + See also + <function>mysqli_errno</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-free-result.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-free-result.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-free-result.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-free-result.xml:1.2 Sun May 18 19:40:46 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-free-result.xml Fri May 23 14:07:23 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-free-result"> <refnamediv> <refname>mysqli_free_result</refname> - <refpurpose>Free the memory associated with a result</refpurpose> + <refpurpose>Frees the memory associated with a result</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,8 +12,9 @@ <methodparam><type>resource</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> - The <function>mysqli_free_result</function> frees the memory associated with - the result represented by the <parameter>result</parameter> parameter. + The <function>mysqli_free_result</function> function frees the memory + associated with the result represented by the + <parameter>result</parameter> parameter. </para> </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml:1.2 Sun May 18 23:54:02 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-get-client-info.xml Fri May 23 14:07:23 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-get-client-info"> <refnamediv> <refname>mysqli_get_client_info</refname> - <refpurpose>Retrun the MySQL client version as a string</refpurpose> + <refpurpose>Returns the MySQL client version as a string</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,8 +12,9 @@ <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> - The <function>mysqli_get_client_info</function> is used to return a string - representing the client version being used in the MySQLi extension. + The <function>mysqli_get_client_info</function> function is used to + return a string representing the client version being used in the + MySQLi extension. </para> </refsect1> </refentry> Index: phpdoc/en/reference/mysqli/functions/mysqli-get-host-info.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-get-host-info.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-get-host-info.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-get-host-info.xml:1.2 Sun May 18 23:54:02 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-get-host-info.xml Fri May 23 14:07:23 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-get-host-info"> <refnamediv> <refname>mysqli_get_host_info</refname> - <refpurpose>Return a string representing the type of connection used</refpurpose> + <refpurpose>Returns a string representing the type of connection used</refpurpose> </refnamediv> <refsect1> <title>Description</title> Index: phpdoc/en/reference/mysqli/functions/mysqli-get-proto-info.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-get-proto-info.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-get-proto-info.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-get-proto-info.xml:1.2 Sun May 18 23:54:02 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-get-proto-info.xml Fri May 23 14:07:23 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-get-proto-info"> <refnamediv> <refname>mysqli_get_proto_info</refname> - <refpurpose>Return the version of the MySQL protocol used</refpurpose> + <refpurpose>Returns the version of the MySQL protocol used</refpurpose> </refnamediv> <refsect1> <title>Description</title> Index: phpdoc/en/reference/mysqli/functions/mysqli-get-server-info.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-get-server-info.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-get-server-info.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-get-server-info.xml:1.2 Sun May 18 23:54:02 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-get-server-info.xml Fri May 23 14:07:23 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-get-server-info"> <refnamediv> <refname>mysqli_get_server_info</refname> - <refpurpose>Return the version of the MySQL server</refpurpose> + <refpurpose>Returns the version of the MySQL server</refpurpose> </refnamediv> <refsect1> <title>Description</title> Index: phpdoc/en/reference/mysqli/functions/mysqli-get-server-version.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-get-server-version.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-get-server-version.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-get-server-version.xml:1.2 Sun May 18 23:54:02 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-get-server-version.xml Fri May 23 14:07:23 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-get-server-version"> <refnamediv> <refname>mysqli_get_server_version</refname> - <refpurpose>Return the version of the MySQL server as an integer</refpurpose> + <refpurpose>Returns the version of the MySQL server as an integer</refpurpose> </refnamediv> <refsect1> <title>Description</title> Index: phpdoc/en/reference/mysqli/functions/mysqli-insert-id.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-insert-id.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-insert-id.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-insert-id.xml:1.2 Sun May 18 23:54:02 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-insert-id.xml Fri May 23 14:07:24 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-insert-id"> <refnamediv> <refname>mysqli_insert_id</refname> - <refpurpose>Get the auto generated id used in the last query</refpurpose> + <refpurpose>Returns the auto generated id used in the last query</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -12,11 +12,11 @@ <methodparam><type>resource</type><parameter>link</parameter></methodparam> </methodsynopsis> <para> - The <function>mysqli_insert_id</function> returns the ID generated by a - query on a table with an column having the AUTO_INCREMENT attribute. If the - last query wasn't an INSERT or UPDATE statement or if the modified table - does not have a column with the AUTO_INCREMENT attribute this function - will return zero. + The <function>mysqli_insert_id</function> function returns the ID generated + by a query on a table with a column having the AUTO_INCREMENT attribute. If + the last query wasn't an INSERT or UPDATE statement or if the modified table + does not have a column with the AUTO_INCREMENT attribute, this function will + return zero. </para> <note> <para> Index: phpdoc/en/reference/mysqli/functions/mysqli-kill.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-kill.xml:1.2 phpdoc/en/reference/mysqli/functions/mysqli-kill.xml:1.3 --- phpdoc/en/reference/mysqli/functions/mysqli-kill.xml:1.2 Thu May 15 05:59:23 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-kill.xml Fri May 23 14:07:24 2003 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.mysqli-kill"> <refnamediv> <refname>mysqli_kill</refname> - <refpurpose>Ask the server to kill a MySQL thread</refpurpose> + <refpurpose>Asks the server to kill a MySQL thread</refpurpose> </refnamediv> <refsect1> <title>Description</title> Index: phpdoc/en/reference/mysqli/functions/mysqli-real-connect.xml diff -u phpdoc/en/reference/mysqli/functions/mysqli-real-connect.xml:1.1 phpdoc/en/reference/mysqli/functions/mysqli-real-connect.xml:1.2 --- phpdoc/en/reference/mysqli/functions/mysqli-real-connect.xml:1.1 Sat Mar 15 18:01:33 2003 +++ phpdoc/en/reference/mysqli/functions/mysqli-real-connect.xml Fri May 23 14:07:24 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.mysqli-real-connect"> <refnamediv> <refname>mysqli_real_connect</refname> @@ -19,6 +19,11 @@ </methodsynopsis> <para> &warn.undocumented.func; + </para> + <para> + See also + <function>mysqli_connect</function> and + <function>mysqli_close</function>. </para> </refsect1> </refentry>