cvs: phpdoc /en/reference/spl cachingiterator.xml /en/reference/spl/cachingiterator construct.xml count.xml getcache.xml getinneriterator.xml
offsetexists.xml offsetget.xml offsetset.xml offsetunset.xml

From: Date: Fri, 14 Nov 2008 19:29:23 +0000
Subject: cvs: phpdoc /en/reference/spl cachingiterator.xml /en/reference/spl/cachingiterator construct.xml count.xml getcache.xml getinneriterator.xml
offsetexists.xml offsetget.xml offsetset.xml offsetunset.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-2532@lists.php.net to get a copy of this message
saltybeagle Fri Nov 14 19:29:23 2008 UTC Modified files: /phpdoc/en/reference/spl/cachingiterator offsetget.xml offsetunset.xml offsetset.xml count.xml construct.xml offsetexists.xml getinneriterator.xml getcache.xml /phpdoc/en/reference/spl cachingiterator.xml Log: Remove or comment out undocumented sections, add info, remove reference to class.iteratoriterator until it can be added in.

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/offsetget.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/offsetget.xml diff -u phpdoc/en/reference/spl/cachingiterator/offsetget.xml:1.1 phpdoc/en/reference/spl/cachingiterator/offsetget.xml:1.2 --- phpdoc/en/reference/spl/cachingiterator/offsetget.xml:1.1 Fri Nov 14 18:56:21 2008 +++ phpdoc/en/reference/spl/cachingiterator/offsetget.xml Fri Nov 14 19:29:23 2008 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/offsetunset.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/offsetunset.xml diff -u phpdoc/en/reference/spl/cachingiterator/offsetunset.xml:1.1 phpdoc/en/reference/spl/cachingiterator/offsetunset.xml:1.2 --- phpdoc/en/reference/spl/cachingiterator/offsetunset.xml:1.1 Fri Nov 14 18:56:21 2008 +++ phpdoc/en/reference/spl/cachingiterator/offsetunset.xml Fri Nov 14 19:29:23 2008 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/offsetset.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/offsetset.xml diff -u phpdoc/en/reference/spl/cachingiterator/offsetset.xml:1.1 phpdoc/en/reference/spl/cachingiterator/offsetset.xml:1.2 --- phpdoc/en/reference/spl/cachingiterator/offsetset.xml:1.1 Fri Nov 14 18:56:21 2008 +++ phpdoc/en/reference/spl/cachingiterator/offsetset.xml Fri Nov 14 19:29:23 2008 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/count.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/count.xml diff -u phpdoc/en/reference/spl/cachingiterator/count.xml:1.1 phpdoc/en/reference/spl/cachingiterator/count.xml:1.2 --- phpdoc/en/reference/spl/cachingiterator/count.xml:1.1 Fri Nov 14 18:56:21 2008 +++ phpdoc/en/reference/spl/cachingiterator/count.xml Fri Nov 14 19:29:23 2008 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/construct.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/construct.xml diff -u phpdoc/en/reference/spl/cachingiterator/construct.xml:1.1 phpdoc/en/reference/spl/cachingiterator/construct.xml:1.2 --- phpdoc/en/reference/spl/cachingiterator/construct.xml:1.1 Fri Nov 14 18:56:21 2008 +++ phpdoc/en/reference/spl/cachingiterator/construct.xml Fri Nov 14 19:29:23 2008 @@ -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"> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/offsetexists.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/offsetexists.xml diff -u phpdoc/en/reference/spl/cachingiterator/offsetexists.xml:1.1 phpdoc/en/reference/spl/cachingiterator/offsetexists.xml:1.2 --- phpdoc/en/reference/spl/cachingiterator/offsetexists.xml:1.1 Fri Nov 14 18:56:21 2008 +++ phpdoc/en/reference/spl/cachingiterator/offsetexists.xml Fri Nov 14 19:29:23 2008 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml diff -u phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml:1.1 phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml:1.2 --- phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml:1.1 Fri Nov 14 18:56:21 2008 +++ phpdoc/en/reference/spl/cachingiterator/getinneriterator.xml Fri Nov 14 19:29:23 2008 @@ -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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator/getcache.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator/getcache.xml diff -u phpdoc/en/reference/spl/cachingiterator/getcache.xml:1.1 phpdoc/en/reference/spl/cachingiterator/getcache.xml:1.2 --- phpdoc/en/reference/spl/cachingiterator/getcache.xml:1.1 Fri Nov 14 18:56:21 2008 +++ phpdoc/en/reference/spl/cachingiterator/getcache.xml Fri Nov 14 19:29:23 2008 @@ -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 http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/spl/cachingiterator.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/spl/cachingiterator.xml diff -u phpdoc/en/reference/spl/cachingiterator.xml:1.5 phpdoc/en/reference/spl/cachingiterator.xml:1.6 --- phpdoc/en/reference/spl/cachingiterator.xml:1.5 Fri Nov 14 18:56:21 2008 +++ phpdoc/en/reference/spl/cachingiterator.xml Fri Nov 14 19:29:23 2008 @@ -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> <!-- }}} -->
« previous php.doc.cvs (#2532) next »