From 255a1f7f9da0ede1e5dc0b7d203a075b3c35b04d Mon Sep 17 00:00:00 2001 From: Mehdi Achour <didou@php.net> Date: Fri, 31 Dec 2004 12:44:55 +0000 Subject: [PATCH] Document DOMCharacterData->xx() git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@176121 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../dom-domcharacterdata-appenddata.xml | 78 ++++++++---- .../dom-domcharacterdata-deletedata.xml | 107 +++++++++++----- .../dom-domcharacterdata-insertdata.xml | 99 ++++++++++----- .../dom-domcharacterdata-replacedata.xml | 118 +++++++++++++----- .../dom-domcharacterdata-substringdata.xml | 105 +++++++++++----- 5 files changed, 359 insertions(+), 148 deletions(-) diff --git a/reference/dom/functions/dom-domcharacterdata-appenddata.xml b/reference/dom/functions/dom-domcharacterdata-appenddata.xml index 57a78cd3f0..d0534b2033 100644 --- a/reference/dom/functions/dom-domcharacterdata-appenddata.xml +++ b/reference/dom/functions/dom-domcharacterdata-appenddata.xml @@ -1,27 +1,59 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> - <refentry id='function.dom-domcharacterdata-appenddata'> - <refnamediv> - <refname>DOMCharacterData->appendData</refname> - <refpurpose> - Append the string to the end of the character data of the node - </refpurpose> - </refnamediv> - <refsect1> - &reftitle.description; - <classsynopsis> - <ooclass><classname>DOMCharacterData</classname></ooclass> - <methodsynopsis> - <type>void</type> - <methodname>appendData</methodname> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - Append the string <parameter>data</parameter> to the end of the character data of the node. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.5 $ --> +<refentry id='function.dom-domcharacterdata-appenddata'> + <refnamediv> + <refname>DOMCharacterData->appendData()</refname> + <refpurpose> + Append the string to the end of the character data of the node + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <classsynopsis> + <ooclass><classname>DOMCharacterData</classname></ooclass> + <methodsynopsis> + <void /> + <methodname>appendData</methodname> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Append the string <parameter>data</parameter> to the end of the character data of the node. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The string to append. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><xref linkend="function.dom-domcharacterdata-deletedata" /></member> + <member><xref linkend="function.dom-domcharacterdata-insertdata" /></member> + <member><xref linkend="function.dom-domcharacterdata-replacedata" /></member> + <member><xref linkend="function.dom-domcharacterdata-substringdata" /></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: diff --git a/reference/dom/functions/dom-domcharacterdata-deletedata.xml b/reference/dom/functions/dom-domcharacterdata-deletedata.xml index 9662f10a12..6994ebcfa7 100644 --- a/reference/dom/functions/dom-domcharacterdata-deletedata.xml +++ b/reference/dom/functions/dom-domcharacterdata-deletedata.xml @@ -1,36 +1,79 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id='function.dom-domcharacterdata-deletedata'> - <refnamediv> - <refname>DOMCharacterData->deleteData</refname> - <refpurpose> - Remove a range of characters from the node - </refpurpose> - </refnamediv> - <refsect1> - &reftitle.description; - <classsynopsis> - <ooclass><classname>DOMCharacterData</classname></ooclass> - <methodsynopsis> - <type>void</type> - <methodname>deleteData</methodname> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - <methodparam><type>int</type><parameter>count</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - Deletes <parameter>count</parameter> characters starting from position - <parameter>offset</parameter>. If the sum of <parameter>offset</parameter> - and <parameter>count</parameter> exceeds the length, then all characters - to the end of the data are deleted. - </para> - <para> - Throws <classname>DOMException</classname> if <parameter>offset</parameter> - is negative or greater than the number of characters in data, or if - <parameter>count</parameter> is negative. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id='function.dom-domcharacterdata-deletedata'> + <refnamediv> + <refname>DOMCharacterData->deleteData()</refname> + <refpurpose> + Remove a range of characters from the node + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <classsynopsis> + <ooclass><classname>DOMCharacterData</classname></ooclass> + <methodsynopsis> + <void/> + <methodname>deleteData</methodname> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + <methodparam><type>int</type><parameter>count</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Deletes <parameter>count</parameter> characters starting from position + <parameter>offset</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The offset from which to start removing. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>count</parameter></term> + <listitem> + <para> + The number of characters to delete. If the sum of + <parameter>offset</parameter> and <parameter>count</parameter> exceeds + the length, then all characters to the end of the data are deleted. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + Throws <classname>DOMException</classname> if <parameter>offset</parameter> + is negative or greater than the number of characters in data, or if + <parameter>count</parameter> is negative. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><xref linkend="function.dom-domcharacterdata-appenddata" /></member> + <member><xref linkend="function.dom-domcharacterdata-insertdata" /></member> + <member><xref linkend="function.dom-domcharacterdata-replacedata" /></member> + <member><xref linkend="function.dom-domcharacterdata-substringdata" /></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: diff --git a/reference/dom/functions/dom-domcharacterdata-insertdata.xml b/reference/dom/functions/dom-domcharacterdata-insertdata.xml index 6f21630cf9..a848a72a2f 100644 --- a/reference/dom/functions/dom-domcharacterdata-insertdata.xml +++ b/reference/dom/functions/dom-domcharacterdata-insertdata.xml @@ -1,32 +1,75 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id='function.dom-domcharacterdata-insertdata'> - <refnamediv> - <refname>DOMCharacterData->insertData</refname> - <refpurpose> - Insert a string at the specified 16-bit unit offset - </refpurpose> - </refnamediv> - <refsect1> - &reftitle.description; - <classsynopsis> - <ooclass><classname>DOMCharacterData</classname></ooclass> - <methodsynopsis> - <type>void</type> - <methodname>insertData</methodname> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - Inserts string <parameter>data</parameter> at position <parameter>offset</parameter>. - </para> - <para> - Throws <classname>DOMException</classname> if <parameter>offset</parameter> - is negative or greater than the number of 16-bit units in data. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id='function.dom-domcharacterdata-insertdata'> + <refnamediv> + <refname>DOMCharacterData->insertData()</refname> + <refpurpose> + Insert a string at the specified 16-bit unit offset + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <classsynopsis> + <ooclass><classname>DOMCharacterData</classname></ooclass> + <methodsynopsis> + <void/> + <methodname>insertData</methodname> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Inserts string <parameter>data</parameter> at position <parameter>offset</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The character offset at which to insert. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The string to insert. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + Throws <classname>DOMException</classname> if <parameter>offset</parameter> + is negative or greater than the number of 16-bit units in data. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><xref linkend="function.dom-domcharacterdata-appenddata" /></member> + <member><xref linkend="function.dom-domcharacterdata-deletedata" /></member> + <member><xref linkend="function.dom-domcharacterdata-replacedata" /></member> + <member><xref linkend="function.dom-domcharacterdata-substringdata" /></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: diff --git a/reference/dom/functions/dom-domcharacterdata-replacedata.xml b/reference/dom/functions/dom-domcharacterdata-replacedata.xml index 7cf6c8a413..6b6cc0cd7b 100644 --- a/reference/dom/functions/dom-domcharacterdata-replacedata.xml +++ b/reference/dom/functions/dom-domcharacterdata-replacedata.xml @@ -1,38 +1,88 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id='function.dom-domcharacterdata-replacedata'> - <refnamediv> - <refname>DOMCharacterData->replaceData</refname> - <refpurpose> - Replace a substring within the DOMCharacterData node - </refpurpose> - </refnamediv> - <refsect1> - &reftitle.description; - <classsynopsis> - <ooclass><classname>DOMCharacterData</classname></ooclass> - <methodsynopsis> - <type>void</type> - <methodname>replaceData</methodname> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - <methodparam><type>int</type><parameter>count</parameter></methodparam> - <methodparam><type>string</type><parameter>data</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - Replace <parameter>count</parameter> characters starting from position - <parameter>offset</parameter> with <parameter>data</parameter>. If the - sum of <parameter>offset</parameter> and <parameter>count</parameter> - exceeds the length, then all characters to the end of the data are - replaced. - </para> - <para> - Throws <classname>DOMException</classname> if <parameter>offset</parameter> - is negative or greater than the number of characters in data, or if - <parameter>count</parameter> is negative. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id='function.dom-domcharacterdata-replacedata'> + <refnamediv> + <refname>DOMCharacterData->replaceData()</refname> + <refpurpose> + Replace a substring within the DOMCharacterData node + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <classsynopsis> + <ooclass><classname>DOMCharacterData</classname></ooclass> + <methodsynopsis> + <void/> + <methodname>replaceData</methodname> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + <methodparam><type>int</type><parameter>count</parameter></methodparam> + <methodparam><type>string</type><parameter>data</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Replace <parameter>count</parameter> characters starting from position + <parameter>offset</parameter> with <parameter>data</parameter>. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + The offset from which to start replacing. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>count</parameter></term> + <listitem> + <para> + The number of characters to replace. If the sum of + <parameter>offset</parameter> and <parameter>count</parameter> exceeds + the length, then all characters to the end of the data are replaced. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>data</parameter></term> + <listitem> + <para> + The string with which the range must be replaced. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + Throws <classname>DOMException</classname> if <parameter>offset</parameter> + is negative or greater than the number of characters in data, or if + <parameter>count</parameter> is negative. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><xref linkend="function.dom-domcharacterdata-appenddata" /></member> + <member><xref linkend="function.dom-domcharacterdata-deletedata" /></member> + <member><xref linkend="function.dom-domcharacterdata-insertdata" /></member> + <member><xref linkend="function.dom-domcharacterdata-substringdata" /></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: diff --git a/reference/dom/functions/dom-domcharacterdata-substringdata.xml b/reference/dom/functions/dom-domcharacterdata-substringdata.xml index f21452f7c1..cfd99b27c0 100644 --- a/reference/dom/functions/dom-domcharacterdata-substringdata.xml +++ b/reference/dom/functions/dom-domcharacterdata-substringdata.xml @@ -1,35 +1,78 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> - <refentry id='function.dom-domcharacterdata-substringdata'> - <refnamediv> - <refname>DOMCharacterData->substringData</refname> - <refpurpose> - Extracts a range of data from the node - </refpurpose> - </refnamediv> - <refsect1> - &reftitle.description; - <classsynopsis> - <ooclass><classname>DOMCharacterData</classname></ooclass> - <methodsynopsis> - <type>string</type> - <methodname>substringData</methodname> - <methodparam><type>int</type><parameter>offset</parameter></methodparam> - <methodparam><type>int</type><parameter>count</parameter></methodparam> - </methodsynopsis> - </classsynopsis> - <para> - Returns the specified substring. If the sum of <parameter>offset</parameter> - and <parameter>count</parameter> exceeds the length, then all 16-bit units - to the end of the data are returned. - </para> - <para> - Throws <classname>DOMException</classname> if <parameter>offset</parameter> - is negative or greater than the number of 16-bit units in data, or if - <parameter>count</parameter> is negative. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.6 $ --> +<refentry id='function.dom-domcharacterdata-substringdata'> + <refnamediv> + <refname>DOMCharacterData->substringData()</refname> + <refpurpose> + Extracts a range of data from the node + </refpurpose> + </refnamediv> + <refsect1 role="description"> + &reftitle.description; + <classsynopsis> + <ooclass><classname>DOMCharacterData</classname></ooclass> + <methodsynopsis> + <type>string</type> + <methodname>substringData</methodname> + <methodparam><type>int</type><parameter>offset</parameter></methodparam> + <methodparam><type>int</type><parameter>count</parameter></methodparam> + </methodsynopsis> + </classsynopsis> + <para> + Returns the specified substring. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>offset</parameter></term> + <listitem> + <para> + Start offset of substring to extract. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>count</parameter></term> + <listitem> + <para> + The number of characters to extract. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + The specified substring. If the sum of <parameter>offset</parameter> + and <parameter>count</parameter> exceeds the length, then all 16-bit units + to the end of the data are returned. + </para> + </refsect1> + <refsect1 role="exceptions"> + &reftitle.exceptions; + <para> + Throws <classname>DOMException</classname> if <parameter>offset</parameter> + is negative or greater than the number of 16-bit units in data, or if + <parameter>count</parameter> is negative. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><xref linkend="function.dom-domcharacterdata-appenddata" /></member> + <member><xref linkend="function.dom-domcharacterdata-deletedata" /></member> + <member><xref linkend="function.dom-domcharacterdata-insertdata" /></member> + <member><xref linkend="function.dom-domcharacterdata-replacedata" /></member> + </simplelist> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: