From 363faa0c125c4dd59d5242b1477e9f0459f44130 Mon Sep 17 00:00:00 2001
From: Brett Bieber <saltybeagle@php.net>
Date: Fri, 14 Nov 2008 19:29:23 +0000
Subject: [PATCH] Remove or comment out undocumented sections, add info, remove
 reference to class.iteratoriterator until it can be added in.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@269016 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/spl/cachingiterator.xml             |  6 +--
 reference/spl/cachingiterator/construct.xml   |  5 +--
 reference/spl/cachingiterator/count.xml       |  4 +-
 reference/spl/cachingiterator/getcache.xml    | 36 +--------------
 .../spl/cachingiterator/getinneriterator.xml  |  4 +-
 .../spl/cachingiterator/offsetexists.xml      | 40 ++---------------
 reference/spl/cachingiterator/offsetget.xml   | 38 +---------------
 reference/spl/cachingiterator/offsetset.xml   | 44 +++----------------
 reference/spl/cachingiterator/offsetunset.xml | 40 ++---------------
 9 files changed, 22 insertions(+), 195 deletions(-)

diff --git a/reference/spl/cachingiterator.xml b/reference/spl/cachingiterator.xml
index 3108f0996b..0ae787b058 100644
--- a/reference/spl/cachingiterator.xml
+++ b/reference/spl/cachingiterator.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.cachingiterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
  <title>The CachingIterator class</title>
  <titleabbrev>CachingIterator</titleabbrev>
@@ -94,10 +94,10 @@
     
     <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.cachingiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-    
+<!--     
     <classsynopsisinfo role="comment">Inherited methods</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.iteratoriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
-
+ -->
    </classsynopsis>
 <!-- }}} -->
 
diff --git a/reference/spl/cachingiterator/construct.xml b/reference/spl/cachingiterator/construct.xml
index 08fa7fc369..a8f5b096b5 100644
--- a/reference/spl/cachingiterator/construct.xml
+++ b/reference/spl/cachingiterator/construct.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="cachingiterator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -17,9 +17,6 @@
   
   &warn.undocumented.func;
   
-  <para>
-   The method description goes here.
-  </para>
  </refsect1>
 
  <refsect1 role="parameters">
diff --git a/reference/spl/cachingiterator/count.xml b/reference/spl/cachingiterator/count.xml
index 9ae6f95cff..650253d957 100644
--- a/reference/spl/cachingiterator/count.xml
+++ b/reference/spl/cachingiterator/count.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="cachingiterator.count" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -29,7 +29,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
+   The count of the elements iterated over.
   </para>
  </refsect1>
 
diff --git a/reference/spl/cachingiterator/getcache.xml b/reference/spl/cachingiterator/getcache.xml
index 0f1534705e..0820157b3e 100644
--- a/reference/spl/cachingiterator/getcache.xml
+++ b/reference/spl/cachingiterator/getcache.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="cachingiterator.getcache" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -16,9 +16,6 @@
   
   &warn.undocumented.func;
   
-  <para>
-   The method description goes here.
-  </para>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -33,37 +30,6 @@
   </para>
  </refsect1>
 
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><function>CachingIterator::getCache</function> example</title>
-    <programlisting role="php">
-<![CDATA[
-<?php
-/* ... */
-?>
-]]>
-    </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
-   </example>
-  </para>
- </refsect1>
-
- <refsect1 role="seealso">
-  &reftitle.seealso;
-  <para>
-   <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
-   </simplelist>
-  </para>
- </refsect1>
-
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/spl/cachingiterator/getinneriterator.xml b/reference/spl/cachingiterator/getinneriterator.xml
index 0f1b9354d6..a49deab803 100644
--- a/reference/spl/cachingiterator/getinneriterator.xml
+++ b/reference/spl/cachingiterator/getinneriterator.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="cachingiterator.getinneriterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -29,7 +29,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
+   Returns an object implementing the Iterator interface.
   </para>
  </refsect1>
 
diff --git a/reference/spl/cachingiterator/offsetexists.xml b/reference/spl/cachingiterator/offsetexists.xml
index ee4bcd5ae6..b21a26bfd0 100644
--- a/reference/spl/cachingiterator/offsetexists.xml
+++ b/reference/spl/cachingiterator/offsetexists.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="cachingiterator.offsetexists" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -16,9 +16,6 @@
   
   &warn.undocumented.func;
   
-  <para>
-   The method description goes here.
-  </para>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +26,7 @@
      <term><parameter>index</parameter></term>
      <listitem>
       <para>
-       Description...
+       The index being checked.
       </para>
      </listitem>
     </varlistentry>
@@ -41,38 +38,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
-  </para>
- </refsect1>
-
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><function>CachingIterator::offsetExists</function> example</title>
-    <programlisting role="php">
-<![CDATA[
-<?php
-/* ... */
-?>
-]]>
-    </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
-   </example>
-  </para>
- </refsect1>
-
- <refsect1 role="seealso">
-  &reftitle.seealso;
-  <para>
-   <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
-   </simplelist>
+   Returns &true; if an entry referenced by the offset exists, &false; otherwise.
   </para>
  </refsect1>
 
diff --git a/reference/spl/cachingiterator/offsetget.xml b/reference/spl/cachingiterator/offsetget.xml
index 88a93321b0..a18c0d3955 100644
--- a/reference/spl/cachingiterator/offsetget.xml
+++ b/reference/spl/cachingiterator/offsetget.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="cachingiterator.offsetget" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -15,10 +15,7 @@
   </methodsynopsis>
   
   &warn.undocumented.func;
-  
-  <para>
-   The method description goes here.
-  </para>
+
  </refsect1>
 
  <refsect1 role="parameters">
@@ -45,37 +42,6 @@
   </para>
  </refsect1>
 
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><function>CachingIterator::offsetGet</function> example</title>
-    <programlisting role="php">
-<![CDATA[
-<?php
-/* ... */
-?>
-]]>
-    </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
-   </example>
-  </para>
- </refsect1>
-
- <refsect1 role="seealso">
-  &reftitle.seealso;
-  <para>
-   <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
-   </simplelist>
-  </para>
- </refsect1>
-
 </refentry>
 
 <!-- Keep this comment at the end of the file
diff --git a/reference/spl/cachingiterator/offsetset.xml b/reference/spl/cachingiterator/offsetset.xml
index 6f935f7cbb..dccbed1d98 100644
--- a/reference/spl/cachingiterator/offsetset.xml
+++ b/reference/spl/cachingiterator/offsetset.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="cachingiterator.offsetset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -16,10 +16,7 @@
   </methodsynopsis>
   
   &warn.undocumented.func;
-  
-  <para>
-   The method description goes here.
-  </para>
+
  </refsect1>
 
  <refsect1 role="parameters">
@@ -30,7 +27,7 @@
      <term><parameter>index</parameter></term>
      <listitem>
       <para>
-       Description...
+       The index of the element to be set.
       </para>
      </listitem>
     </varlistentry>
@@ -38,7 +35,7 @@
      <term><parameter>newval</parameter></term>
      <listitem>
       <para>
-       Description...
+       The new value for the <parameter>index</parameter>.
       </para>
      </listitem>
     </varlistentry>
@@ -50,38 +47,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
-  </para>
- </refsect1>
-
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><function>CachingIterator::offsetSet</function> example</title>
-    <programlisting role="php">
-<![CDATA[
-<?php
-/* ... */
-?>
-]]>
-    </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
-   </example>
-  </para>
- </refsect1>
-
- <refsect1 role="seealso">
-  &reftitle.seealso;
-  <para>
-   <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
-   </simplelist>
+   &return.void;
   </para>
  </refsect1>
 
diff --git a/reference/spl/cachingiterator/offsetunset.xml b/reference/spl/cachingiterator/offsetunset.xml
index 5c18ff620d..9bacb94598 100644
--- a/reference/spl/cachingiterator/offsetunset.xml
+++ b/reference/spl/cachingiterator/offsetunset.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 
 <refentry xml:id="cachingiterator.offsetunset" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
@@ -16,9 +16,6 @@
   
   &warn.undocumented.func;
   
-  <para>
-   The method description goes here.
-  </para>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -29,7 +26,7 @@
      <term><parameter>index</parameter></term>
      <listitem>
       <para>
-       Description...
+       The index of the element to be unset.
       </para>
      </listitem>
     </varlistentry>
@@ -41,38 +38,7 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Description...
-  </para>
- </refsect1>
-
- <refsect1 role="examples">
-  &reftitle.examples;
-  <para>
-   <example>
-    <title><function>CachingIterator::offsetUnset</function> example</title>
-    <programlisting role="php">
-<![CDATA[
-<?php
-/* ... */
-?>
-]]>
-    </programlisting>
-    &example.outputs.similar;
-    <screen>
-<![CDATA[
-...
-]]>
-    </screen>
-   </example>
-  </para>
- </refsect1>
-
- <refsect1 role="seealso">
-  &reftitle.seealso;
-  <para>
-   <simplelist>
-    <member><methodname>Classname::Method</methodname></member>
-   </simplelist>
+   &return.void;
   </para>
  </refsect1>