From 49e5833d21970fe7ea896404452226c0ffa2f7b8 Mon Sep 17 00:00:00 2001
From: Jakub Vrana <vrana@php.net>
Date: Fri, 13 Nov 2009 23:00:18 +0000
Subject: [PATCH] Document mysqli_warning (bug #49298)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@290722 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/mysqli/book.xml                     |   1 +
 reference/mysqli/mysqli/get-warnings.xml      |   4 +-
 reference/mysqli/mysqli_warning.xml           | 108 ++++++++++++++++++
 reference/mysqli/mysqli_warning/construct.xml |  58 ++++++++++
 reference/mysqli/mysqli_warning/next.xml      |  58 ++++++++++
 5 files changed, 227 insertions(+), 2 deletions(-)
 create mode 100644 reference/mysqli/mysqli_warning.xml
 create mode 100644 reference/mysqli/mysqli_warning/construct.xml
 create mode 100644 reference/mysqli/mysqli_warning/next.xml

diff --git a/reference/mysqli/book.xml b/reference/mysqli/book.xml
index 127532774e..d6c0e5f818 100644
--- a/reference/mysqli/book.xml
+++ b/reference/mysqli/book.xml
@@ -60,6 +60,7 @@
  &reference.mysqli.mysqli-stmt;
  &reference.mysqli.mysqli-result;
  &reference.mysqli.mysqli-driver;
+ &reference.mysqli.mysqli-warning;
  &reference.mysqli.reference;
 
 </book>
diff --git a/reference/mysqli/mysqli/get-warnings.xml b/reference/mysqli/mysqli/get-warnings.xml
index c2941d9d7b..ff2a768110 100644
--- a/reference/mysqli/mysqli/get-warnings.xml
+++ b/reference/mysqli/mysqli/get-warnings.xml
@@ -10,12 +10,12 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>object</type><methodname>mysqli::get_warnings</methodname>
+   <type>mysqli_warnings</type><methodname>mysqli::get_warnings</methodname>
    <void />
   </methodsynopsis>
 
   <methodsynopsis>
-   <type>object</type><methodname>mysqli_get_warnings</methodname>
+   <type>mysqli_warnings</type><methodname>mysqli_get_warnings</methodname>
    <methodparam><type>mysqli</type><parameter>link</parameter></methodparam>
   </methodsynopsis>
 
diff --git a/reference/mysqli/mysqli_warning.xml b/reference/mysqli/mysqli_warning.xml
new file mode 100644
index 0000000000..da611d71e2
--- /dev/null
+++ b/reference/mysqli/mysqli_warning.xml
@@ -0,0 +1,108 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 288721 $ -->
+<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.mysqli-warning" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+ <title>The MySQLi_Warning class</title>
+ <titleabbrev>MySQLi_Warning</titleabbrev>
+ 
+ <partintro>
+ 
+<!-- {{{ ClassName intro -->
+  <section xml:id="mysqli-warning.intro">
+   &reftitle.intro;
+   <para>
+    Represents a MySQL warning.
+   </para>
+  </section>
+<!-- }}} -->
+ 
+  <section xml:id="mysqli-warning.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>mysqli_warning</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>mysqli_warning</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+    <classsynopsisinfo role="comment">Properties</classsynopsisinfo>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <varname linkend="mysqli-warning.props.message">message</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <varname linkend="mysqli-warning.props.sqlstate">sqlstate</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <varname linkend="mysqli-warning.props.errno">errno</varname>
+    </fieldsynopsis>
+
+    
+    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mysqli-warning')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+  
+<!-- {{{ mysqli_warning properties -->
+  <section xml:id="mysqli-warning.props">
+   &reftitle.properties;
+   <variablelist>
+    <varlistentry xml:id="mysqli-warning.props.message">
+     <term><varname>message</varname></term>
+     <listitem>
+      <para>Message string</para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="mysqli-warning.props.sqlstate">
+     <term><varname>sqlstate</varname></term>
+     <listitem>
+      <para>SQL state</para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="mysqli-warning.props.errno">
+     <term><varname>errno</varname></term>
+     <listitem>
+      <para>Error number</para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </section>
+<!-- }}} -->
+
+
+ </partintro>
+
+ &reference.mysqli.entities.mysqli-warning;
+
+</phpdoc:classref>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+
diff --git a/reference/mysqli/mysqli_warning/construct.xml b/reference/mysqli/mysqli_warning/construct.xml
new file mode 100644
index 0000000000..780c79804e
--- /dev/null
+++ b/reference/mysqli/mysqli_warning/construct.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: $ -->
+
+<refentry xml:id="mysqli-warning.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>mysqli_warning::__construct</refname>
+  <refpurpose>The __construct purpose</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <methodname>mysqli_warning::__construct</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/mysqli/mysqli_warning/next.xml b/reference/mysqli/mysqli_warning/next.xml
new file mode 100644
index 0000000000..f77684bcdb
--- /dev/null
+++ b/reference/mysqli/mysqli_warning/next.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: $ -->
+
+<refentry xml:id="mysqli-warning.next" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>mysqli_warning::next</refname>
+  <refpurpose>The next purpose</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>void</type><methodname>mysqli_warning::next</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+
+  </para>
+
+  &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+
+  </para>
+ </refsect1>
+
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->