From 5f549208e08a86c1c3d9d6af8e81db1d12e6b77d Mon Sep 17 00:00:00 2001
From: Mehdi Achour <didou@php.net>
Date: Fri, 31 Dec 2004 13:02:22 +0000
Subject: [PATCH] Document DOMNamedMap->XX() and remove DOMStringList (not
 implemented and not sure it have to be documented anyway)

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@176122 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../dom-domnamednodemap-getnameditem.xml      | 76 +++++++++++-----
 .../dom-domnamednodemap-getnameditemns.xml    | 88 +++++++++++++------
 .../functions/dom-domnamednodemap-item.xml    | 67 +++++++++-----
 .../dom/functions/dom-domstringlist-item.xml  | 45 ----------
 reference/dom/reference.xml                   | 49 +----------
 5 files changed, 163 insertions(+), 162 deletions(-)
 delete mode 100644 reference/dom/functions/dom-domstringlist-item.xml

diff --git a/reference/dom/functions/dom-domnamednodemap-getnameditem.xml b/reference/dom/functions/dom-domnamednodemap-getnameditem.xml
index 682d28469b..2f950765f9 100644
--- a/reference/dom/functions/dom-domnamednodemap-getnameditem.xml
+++ b/reference/dom/functions/dom-domnamednodemap-getnameditem.xml
@@ -1,27 +1,57 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-  <refentry id='function.dom-domnamednodemap-getnameditem'>
-   <refnamediv>
-    <refname>DOMNamedNodeMap->getNamedItem</refname>
-    <refpurpose>
-     Retrieves a node specified by name
-    </refpurpose>
-   </refnamediv>
-   <refsect1>
-    &reftitle.description;
-    <classsynopsis>
-     <ooclass><classname>DOMNamedNodeMap</classname></ooclass>
-     <methodsynopsis>
-      <type>DOMNode</type>
-      <methodname>getNamedItem</methodname>
-      <methodparam><type>string</type><parameter>name</parameter></methodparam>
-     </methodsynopsis>
-    </classsynopsis>
-    <para>
-     Retrieves a node specified by <parameter>name</parameter>.
-    </para>
-   </refsect1>
-  </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id='function.dom-domnamednodemap-getnameditem'>
+ <refnamediv>
+  <refname>DOMNamedNodeMap->getNamedItem()</refname>
+  <refpurpose>
+   Retrieves a node specified by name
+  </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <classsynopsis>
+   <ooclass><classname>DOMNamedNodeMap</classname></ooclass>
+   <methodsynopsis>
+    <type>DOMNode</type>
+    <methodname>getNamedItem</methodname>
+    <methodparam><type>string</type><parameter>name</parameter></methodparam>
+   </methodsynopsis>
+  </classsynopsis>
+  <para>
+   Retrieves a node specified by its <literal>nodeName</literal>.
+  </para>
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>name</parameter></term>
+     <listitem>
+      <para>
+       The <literal>nodeName</literal> of the node to retrieve.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   A node (of any type) with the specified <literal>nodeName</literal>, or 
+   &null; if no node is found.
+  </para>
+ </refsect1>
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><xref linkend="function.dom-domnamednodemap-getnameditemns" /></member>
+   </simplelist>
+  </para>
+ </refsect1>
+</refentry>
 
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/dom/functions/dom-domnamednodemap-getnameditemns.xml b/reference/dom/functions/dom-domnamednodemap-getnameditemns.xml
index a827ce5ac5..e5d8a3eaf8 100644
--- a/reference/dom/functions/dom-domnamednodemap-getnameditemns.xml
+++ b/reference/dom/functions/dom-domnamednodemap-getnameditemns.xml
@@ -1,29 +1,67 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-  <refentry id='function.dom-domnamednodemap-getnameditemns'>
-   <refnamediv>
-    <refname>DOMNamedNodeMap->getNamedItemNS</refname>
-    <refpurpose>
-     Retrieves a node specified by local name and namespace URI
-    </refpurpose>
-   </refnamediv>
-   <refsect1>
-    &reftitle.description;
-    <classsynopsis>
-     <ooclass><classname>DOMNamedNodeMap</classname></ooclass>
-     <methodsynopsis>
-      <type>DOMNode</type>
-      <methodname>getNamedItemNS</methodname>
-      <methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
-      <methodparam><type>string</type><parameter>localName</parameter></methodparam>
-     </methodsynopsis>
-    </classsynopsis>
-    <para>
-     Retrieves a node specified by <parameter>localName</parameter> and 
-     <parameter>namespaceURI</parameter>.
-    </para>
-   </refsect1>
-  </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id='function.dom-domnamednodemap-getnameditemns'>
+ <refnamediv>
+  <refname>DOMNamedNodeMap->getNamedItemNS()</refname>
+  <refpurpose>
+   Retrieves a node specified by local name and namespace URI
+  </refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <classsynopsis>
+   <ooclass><classname>DOMNamedNodeMap</classname></ooclass>
+   <methodsynopsis>
+    <type>DOMNode</type>
+    <methodname>getNamedItemNS</methodname>
+    <methodparam><type>string</type><parameter>namespaceURI</parameter></methodparam>
+    <methodparam><type>string</type><parameter>localName</parameter></methodparam>
+   </methodsynopsis>
+  </classsynopsis>
+  <para>
+   Retrieves a node specified by <parameter>localName</parameter> and 
+   <parameter>namespaceURI</parameter>.
+  </para>
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>namespaceURI</parameter></term>
+     <listitem>
+      <para>
+       The namespace URI of the node to retrieve.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term><parameter>localName</parameter></term>
+     <listitem>
+      <para>
+       The local name of the node to retrieve.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   A node (of any type) with the specified local name and namespace URI, or 
+   &null; if no node is found.
+  </para>
+ </refsect1>
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><xref linkend="function.dom-domnamednodemap-getnameditem" /></member>
+   </simplelist>
+  </para>
+ </refsect1>
+</refentry>
 
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/dom/functions/dom-domnamednodemap-item.xml b/reference/dom/functions/dom-domnamednodemap-item.xml
index 5bca5f72d5..a57e671e00 100644
--- a/reference/dom/functions/dom-domnamednodemap-item.xml
+++ b/reference/dom/functions/dom-domnamednodemap-item.xml
@@ -1,26 +1,49 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-  <refentry id='function.dom-domnamednodemap-item'>
-   <refnamediv>
-    <refname>DOMNamedNodeMap->item</refname>
-    <refpurpose>Retrieves a node specified by index</refpurpose>
-   </refnamediv>
-   <refsect1>
-    &reftitle.description;
-    <classsynopsis>
-     <ooclass><classname>DOMNamedNodeMap</classname></ooclass>
-     <methodsynopsis>
-      <type>DOMNode</type>
-      <methodname>item</methodname>
-      <methodparam><type>int</type><parameter>index</parameter></methodparam>
-     </methodsynopsis>
-    </classsynopsis>
-    <para>
-     Retrieves a node specified by <parameter>index</parameter> within the 
-     DOMNamedNodeMap object.
-    </para>
-   </refsect1>
-  </refentry>
+<!-- $Revision: 1.6 $ -->
+<refentry id='function.dom-domnamednodemap-item'>
+ <refnamediv>
+  <refname>DOMNamedNodeMap->item()</refname>
+  <refpurpose>Retrieves a node specified by index</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <classsynopsis>
+   <ooclass><classname>DOMNamedNodeMap</classname></ooclass>
+   <methodsynopsis>
+    <type>DOMNode</type>
+    <methodname>item</methodname>
+    <methodparam><type>int</type><parameter>index</parameter></methodparam>
+   </methodsynopsis>
+  </classsynopsis>
+  <para>
+   Retrieves a node specified by <parameter>index</parameter> within the 
+   <classname>DOMNamedNodeMap</classname> object.
+  </para>
+ </refsect1>
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>index</parameter></term>
+     <listitem>
+      <para>
+       Index into this map.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   The node at the <parameter>index</parameter>th position in the map, or &null;
+   if that is not a valid index (greater than or equal to the number of nodes 
+   in this map).
+  </para>
+ </refsect1>
+</refentry>
 
 <!-- Keep this comment at the end of the file
 Local variables:
diff --git a/reference/dom/functions/dom-domstringlist-item.xml b/reference/dom/functions/dom-domstringlist-item.xml
deleted file mode 100644
index 61182569bc..0000000000
--- a/reference/dom/functions/dom-domstringlist-item.xml
+++ /dev/null
@@ -1,45 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
-  <refentry id='function.dom-domstringlist-item'>
-   <refnamediv>
-    <refname>DOMStringList->item</refname>
-    <refpurpose>
-     Return the specified index of the collection
-    </refpurpose>
-   </refnamediv>
-   <refsect1>
-    &reftitle.description;
-    <classsynopsis>
-     <ooclass><classname>DOMStringList</classname></ooclass>
-     <methodsynopsis>
-      <type>DOMString</type>
-      <methodname>item</methodname>
-      <methodparam><type>int</type><parameter>index</parameter></methodparam>
-     </methodsynopsis>
-    </classsynopsis>
-    <para>
-     Not implemented yet.
-    </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/dom/reference.xml b/reference/dom/reference.xml
index a9302d3b7a..04f0c07484 100644
--- a/reference/dom/reference.xml
+++ b/reference/dom/reference.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.13 $ -->
+<!-- $Revision: 1.14 $ -->
  <reference id="ref.dom">
   <title>DOM Functions</title>
   <titleabbrev>DOM</titleabbrev>
@@ -733,7 +733,6 @@
       </itemizedlist>
      </section>
     </section>
-
     
     <section id='dom.class.domnamelist'>
      <title><classname>DOMNameList</classname></title>
@@ -781,7 +780,6 @@
      </section>
     </section>
 
-   
     <section id='dom.class.domnode'>
      <title><classname>DOMNode</classname></title>
      <section id='dom.class.domnode.methods'>
@@ -1013,7 +1011,6 @@
       </table>     
      </section>
     </section>
-
     
     <section id='dom.class.domprocessinginstruction'>
      <title><classname>DOMProcessingInstruction</classname></title>
@@ -1051,48 +1048,7 @@
       </table>     
      </section>
     </section>
-    
-    <section id='dom.class.domstringlist'>
-     <title><classname>DOMStringList</classname></title>
-     <para>
-      
-     </para>
-     <section id='dom.class.domstringlist.methods'>
-      &reftitle.methods;
-      <itemizedlist>
-       <listitem>
-        <para><xref linkend='function.dom-domstringlist-item' /> - Return the specified index of the collection</para>
-       </listitem>
-      </itemizedlist>
-     </section>
-     <section id='dom.class.domstringlist.properties'>
-      &reftitle.properties;
-      <table>
-      <title/>
-      <tgroup cols="4">
-        <thead>
-         <row>
-          <entry>Name</entry>
-          <entry>Type</entry>
-          <entry>Read-only</entry>
-          <entry>Description</entry>
-         </row>
-        </thead>
-        <tbody>
-         <row>
-          <entry>length</entry>
-          <entry>int</entry>
-          <entry>yes</entry>
-          <entry>
-           The number of DOMStrings in the list. Not implemented yet, always return &true;.
-          </entry>
-         </row>
-        </tbody>
-       </tgroup>
-      </table>     
-     </section>
-    </section>
-    
+   
     <section id='dom.class.domtext'>
      <title><classname>DOMText</classname></title>
      <para>
@@ -1135,7 +1091,6 @@
      </section>
     </section>
     
-    
     <section id='dom.class.domxpath'>
      <title><classname>DOMXPath</classname></title>
      <para>