[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] svn: /phpdoc/en/trunk/reference/spl/ interfaces.xml outeriterator/getinneriterator.xml out
From: Joris_van_de_Sande <joris () php ! net>
Date: 2009-08-27 19:01:36
Message-ID: svn-joris-1251399696-287818-673001407 () svn ! php ! net
[Download RAW message or body]
joris Thu, 27 Aug 2009 19:01:36 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=287818
Log:
- Added documentation for OuterIterator interface (without examples at the moment)
- Updated description for RecursiveIterator interface
- Updated description for RecursiveIteratorIterator class
Changed paths:
U phpdoc/en/trunk/reference/spl/interfaces.xml
A phpdoc/en/trunk/reference/spl/outeriterator/
A phpdoc/en/trunk/reference/spl/outeriterator/getinneriterator.xml
A phpdoc/en/trunk/reference/spl/outeriterator.xml
U phpdoc/en/trunk/reference/spl/recursiveiterator.xml
U phpdoc/en/trunk/reference/spl/recursiveiteratoriterator.xml
["svn-diffs-287818.txt" (text/x-diff)]
Modified: phpdoc/en/trunk/reference/spl/interfaces.xml
===================================================================
--- phpdoc/en/trunk/reference/spl/interfaces.xml 2009-08-27 18:39:56 UTC (rev 287817)
+++ phpdoc/en/trunk/reference/spl/interfaces.xml 2009-08-27 19:01:36 UTC (rev 287818)
@@ -29,10 +29,10 @@
</partintro>
&reference.spl.countable;
+ &reference.spl.outeriterator;
&reference.spl.recursiveiterator;
&reference.spl.seekableiterator;
<!-- TODO: Not documented
- &reference.spl.outeriterator;
&reference.spl.splobserver;
&reference.spl.splsubject;
-->
Added: phpdoc/en/trunk/reference/spl/outeriterator/getinneriterator.xml
===================================================================
--- phpdoc/en/trunk/reference/spl/outeriterator/getinneriterator.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/spl/outeriterator/getinneriterator.xml 2009-08-27 \
19:01:36 UTC (rev 287818) @@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 283837 $ -->
+<refentry xml:id="outeriterator.getchildren" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+ <refname>OuterIterator::getInnerIterator</refname>
+ <refpurpose>Returns the inner iterator for the current entry.</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier> \
<type>Iterator</type><methodname>OuterIterator::getInnerIterator</methodname> + \
<void/> + </methodsynopsis>
+ <para>
+ Returns the inner iterator for the current iterator entry.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ The inner iterator for the current entry.
+ </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
+-->
Added: phpdoc/en/trunk/reference/spl/outeriterator.xml
===================================================================
--- phpdoc/en/trunk/reference/spl/outeriterator.xml (rev 0)
+++ phpdoc/en/trunk/reference/spl/outeriterator.xml 2009-08-27 19:01:36 UTC (rev \
287818) @@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 283837 $ -->
+
+<phpdoc:classref xml:id="class.outeriterator" \
xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink" \
xmlns:xi="http://www.w3.org/2001/XInclude"> +
+ <title>The OuterIterator interface</title>
+ <titleabbrev>OuterIterator</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ OuterIterator intro -->
+ <section xml:id="outeriterator.intro">
+ &reftitle.intro;
+ <para>
+ Classes implementing <classname>OuterIterator</classname> can be used to iterate
+ over iterators.
+ </para>
+ </section>
+<!-- }}} -->
+
+ <section xml:id="outeriterator.synopsis">
+ &reftitle.interfacesynopsis;
+
+<!-- {{{ Synopsis -->
+ <classsynopsis>
+ <ooclass><classname>OuterIterator</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+ <classsynopsisinfo>
+ <ooclass>
+ <classname>OuterIterator</classname>
+ </ooclass>
+
+ <ooclass>
+ <modifier>extends</modifier>
+ <classname>Iterator</classname>
+ </ooclass>
+
+ </classsynopsisinfo>
+<!-- }}} -->
+
+ <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.outeriterator')/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.iterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" \
/> + </classsynopsis>
+<!-- }}} -->
+
+ </section>
+
+ </partintro>
+
+ &reference.spl.entities.outeriterator;
+
+</phpdoc:classref>
+
+<!-- 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
+-->
+
Modified: phpdoc/en/trunk/reference/spl/recursiveiterator.xml
===================================================================
--- phpdoc/en/trunk/reference/spl/recursiveiterator.xml 2009-08-27 18:39:56 UTC (rev \
287817)
+++ phpdoc/en/trunk/reference/spl/recursiveiterator.xml 2009-08-27 19:01:36 UTC (rev \
287818) @@ -13,7 +13,7 @@
&reftitle.intro;
<para>
Classes implementing <classname>RecursiveIterator</classname> can be used to \
iterate
- over iterators.
+ over iterators recursively.
</para>
</section>
<!-- }}} -->
Modified: phpdoc/en/trunk/reference/spl/recursiveiteratoriterator.xml
===================================================================
--- phpdoc/en/trunk/reference/spl/recursiveiteratoriterator.xml 2009-08-27 18:39:56 \
UTC (rev 287817)
+++ phpdoc/en/trunk/reference/spl/recursiveiteratoriterator.xml 2009-08-27 19:01:36 \
UTC (rev 287818) @@ -3,25 +3,25 @@
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" \
xml:id="class.recursiveiteratoriterator" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink" \
xmlns:xi="http://www.w3.org/2001/XInclude"> <title>The RecursiveIteratorIterator \
class</title> <titleabbrev>RecursiveIteratorIterator</titleabbrev>
-
+
<partintro>
-
+
<!-- {{{ RecursiveIteratorIterator intro -->
<section xml:id="recursiveiteratoriterator.intro">
&reftitle.intro;
<para>
- ...
+ Can be used to iterate through recursive iterators.
</para>
</section>
<!-- }}} -->
-
+
<section xml:id="recursiveiteratoriterator.synopsis">
&reftitle.classsynopsis;
-
+
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>RecursiveIteratorIterator</classname></ooclass>
-
+
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
@@ -31,18 +31,18 @@
<oointerface>
<interfacename>OuterIterator</interfacename>
</oointerface>
-
+
<oointerface>
<interfacename>Traversable</interfacename>
</oointerface>
-
+
<oointerface>
<interfacename>Iterator</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
-
+
<!-- {{{ If the property is documented below \
(xml:id=recursiveiteratoriterator.props) use this <classsynopsisinfo \
role="comment">Properties</classsynopsisinfo> <fieldsynopsis>
@@ -51,13 +51,16 @@
<varname linkend="recursiveiteratoriterator.props.name">name</varname>
</fieldsynopsis>
}}} -->
-
+
<classsynopsisinfo role="comment">Methods</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) \
xpointer(id('class.recursiveiteratoriterator')/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.outeriterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" \
/> </classsynopsis>
-
+
</section>
-
+
<!-- {{{ RecursiveIteratorIterator properties
<section xml:id="recursiveiteratoriterator.props">
&reftitle.properties;
@@ -71,13 +74,13 @@
</variablelist>
</section>
}}} -->
-
+
</partintro>
-
+
&reference.spl.entities.recursiveiteratoriterator;
-
+
</phpdoc:classref>
-
+
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic