didou Sat Feb 5 19:41:24 2005 EDT
Modified files:
/phpdoc/en/reference/xml/functions xml-get-current-byte-index.xml
xml-get-current-column-number.xml
xml-get-current-line-number.xml
xml-get-error-code.xml
xml-error-string.xml
xml-parse.xml
Log:
Switch to the new structure
# also added see also and description
http://cvs.php.net/diff.php/phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml
diff -u phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml:1.4
phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml:1.5
--- phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml:1.4
Mon Mar 29 09:35:03 2004
+++ phpdoc/en/reference/xml/functions/xml-get-current-byte-index.xml Sat Feb
5 19:41:24 2005
@@ -1,35 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.xml-get-current-byte-index">
<refnamediv>
<refname>xml_get_current_byte_index</refname>
<refpurpose>Get current byte index for an XML parser</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>xml_get_current_byte_index</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
</methodsynopsis>
<para>
+ Gets the current byte index of the given XML parser.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
+ <para>
A reference to the XML parser to get byte index from.
- </simpara>
+ </para>
</listitem>
</varlistentry>
</variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
This function returns &false; if <parameter>parser</parameter> does
not refer to a valid parser, or else it returns which byte index
the parser is currently at in its data buffer (starting at 0).
</para>
</refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>xml_get_current_column_index</function></member>
+ <member><function>xml_get_current_line_index</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/diff.php/phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml
diff -u phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml:1.3
phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml:1.4
--- phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml:1.3
Fri Apr 19 07:11:21 2002
+++ phpdoc/en/reference/xml/functions/xml-get-current-column-number.xml Sat Feb
5 19:41:24 2005
@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
-<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.xml-get-current-column-number">
<refnamediv>
<refname>xml_get_current_column_number</refname>
@@ -8,24 +7,33 @@
Get current column number for an XML parser
</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>xml_get_current_column_number</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
</methodsynopsis>
<para>
+ Gets the current column number of the given XML parser.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
+ <para>
A reference to the XML parser to get column number from.
- </simpara>
+ </para>
</listitem>
</varlistentry>
</variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
This function returns &false; if <parameter>parser</parameter> does
not refer to a valid parser, or else it returns which column on
@@ -34,6 +42,15 @@
currently at.
</para>
</refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>xml_get_current_byte_index</function></member>
+ <member><function>xml_get_current_line_index</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/diff.php/phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml
diff -u phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml:1.4
phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml:1.5
--- phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml:1.4
Mon Mar 29 09:35:03 2004
+++ phpdoc/en/reference/xml/functions/xml-get-current-line-number.xml Sat Feb
5 19:41:24 2005
@@ -1,35 +1,52 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.xml-get-current-line-number">
<refnamediv>
<refname>xml_get_current_line_number</refname>
<refpurpose>Get current line number for an XML parser</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>xml_get_current_line_number</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
</methodsynopsis>
<para>
+ Gets the current line number for the given XML parser.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
+ <para>
A reference to the XML parser to get line number from.
- </simpara>
+ </para>
</listitem>
</varlistentry>
</variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
This function returns &false; if <parameter>parser</parameter> does
not refer to a valid parser, or else it returns which line the
parser is currently at in its data buffer.
</para>
</refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>xml_get_current_column_index</function></member>
+ <member><function>xml_get_current_byte_index</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/diff.php/phpdoc/en/reference/xml/functions/xml-get-error-code.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/xml/functions/xml-get-error-code.xml
diff -u phpdoc/en/reference/xml/functions/xml-get-error-code.xml:1.5
phpdoc/en/reference/xml/functions/xml-get-error-code.xml:1.6
--- phpdoc/en/reference/xml/functions/xml-get-error-code.xml:1.5 Mon Mar
29 09:35:03 2004
+++ phpdoc/en/reference/xml/functions/xml-get-error-code.xml Sat Feb 5
19:41:24 2005
@@ -1,37 +1,50 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.xml-get-error-code">
<refnamediv>
<refname>xml_get_error_code</refname>
<refpurpose>Get XML parser error code</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>int</type><methodname>xml_get_error_code</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
</methodsynopsis>
<para>
+ Gets the XML parser error code.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
+ <para>
A reference to the XML parser to get error code from.
- </simpara>
+ </para>
</listitem>
</varlistentry>
</variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
This function returns &false; if <parameter>parser</parameter> does
not refer to a valid parser, or else it returns one of the error
codes listed in the <link linkend="xml.error-codes">error codes
section</link>.
</para>
+ </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>xml_error_string</function>.
+ <simplelist>
+ <member><function>xml_error_string</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/xml/functions/xml-error-string.xml?r1=1.5&r2=1.6&ty=u
Index: phpdoc/en/reference/xml/functions/xml-error-string.xml
diff -u phpdoc/en/reference/xml/functions/xml-error-string.xml:1.5
phpdoc/en/reference/xml/functions/xml-error-string.xml:1.6
--- phpdoc/en/reference/xml/functions/xml-error-string.xml:1.5 Mon Mar 29
09:35:03 2004
+++ phpdoc/en/reference/xml/functions/xml-error-string.xml Sat Feb 5
19:41:24 2005
@@ -1,34 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.xml-error-string">
<refnamediv>
<refname>xml_error_string</refname>
<refpurpose>Get XML parser error string</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>xml_error_string</methodname>
<methodparam><type>int</type><parameter>code</parameter></methodparam>
</methodsynopsis>
<para>
+ Gets the XML parser error string associated with the given
+ <parameter>code</parameter>.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
<variablelist>
<varlistentry>
<term><parameter>code</parameter></term>
<listitem>
- <simpara>
+ <para>
An error code from <function>xml_get_error_code</function>.
- </simpara>
+ </para>
</listitem>
</varlistentry>
</variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
Returns a string with a textual description of the error
<parameter>code</parameter>, or &false; if no description was found.
</para>
</refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><function>xml_get_error_code</function></member>
+ </simplelist>
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/diff.php/phpdoc/en/reference/xml/functions/xml-parse.xml?r1=1.4&r2=1.5&ty=u
Index: phpdoc/en/reference/xml/functions/xml-parse.xml
diff -u phpdoc/en/reference/xml/functions/xml-parse.xml:1.4
phpdoc/en/reference/xml/functions/xml-parse.xml:1.5
--- phpdoc/en/reference/xml/functions/xml-parse.xml:1.4 Mon Mar 29 09:35:03 2004
+++ phpdoc/en/reference/xml/functions/xml-parse.xml Sat Feb 5 19:41:24 2005
@@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/xml.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.xml-parse">
<refnamediv>
<refname>xml_parse</refname>
<refpurpose>Start parsing an XML document</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>xml_parse</methodname>
<methodparam><type>resource</type><parameter>parser</parameter></methodparam>
@@ -15,47 +14,53 @@
<methodparam
choice="opt"><type>bool</type><parameter>is_final</parameter></methodparam>
</methodsynopsis>
<para>
+ <function>xml_parse</function> parses an XML document. The handlers for
+ the configured events are called as many times as necessary.
+ </para>
+ </refsect1>
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
<variablelist>
<varlistentry>
<term><parameter>parser</parameter></term>
<listitem>
- <simpara>
+ <para>
A reference to the XML parser to use.
- </simpara>
+ </para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>data</parameter></term>
<listitem>
- <simpara>
+ <para>
Chunk of data to parse. A document may be parsed piece-wise by
calling <function>xml_parse</function> several times with new data,
as long as the <parameter>is_final</parameter> parameter is set and
&true; when the last data is parsed.
- </simpara>
+ </para>
</listitem>
</varlistentry>
<varlistentry>
- <term><parameter>is_final</parameter> (optional)</term>
+ <term><parameter>is_final</parameter></term>
<listitem>
- <simpara>
+ <para>
If set and &true;, <parameter>data</parameter> is the last piece of
data sent in this parse.
- </simpara>
+ </para>
</listitem>
</varlistentry>
</variablelist>
</para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
<para>
- When the XML document is parsed, the handlers for the configured
- events are called as many times as necessary, after which this
- function returns &true; or &false;.
+ &return.success;
</para>
<para>
- &true; is returned if the parse was successful, &false; if it was not
- successful, or if <parameter>parser</parameter> does not refer to
- a valid parser. For unsuccessful parses, error information can
- be retrieved with <function>xml_get_error_code</function>,
+ For unsuccessful parses, error information can be retrieved with
+ <function>xml_get_error_code</function>,
<function>xml_error_string</function>,
<function>xml_get_current_line_number</function>,
<function>xml_get_current_column_number</function> and
