svn: /phpdoc/en/trunk/reference/spl/parentiterator/ accept.xml construct.xml
| From: | Philip Olson | Date: | Thu, 08 Oct 2009 15:38:13 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/spl/parentiterator/ accept.xml construct.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-5106@lists.php.net to get a copy of this message | ||
philip Thu, 08 Oct 2009 15:38:13 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=289348
Log:
Finished skeletons for ParentIterator
Changed paths:
A phpdoc/en/trunk/reference/spl/parentiterator/accept.xml
A phpdoc/en/trunk/reference/spl/parentiterator/construct.xml
Added: phpdoc/en/trunk/reference/spl/parentiterator/accept.xml
===================================================================
--- phpdoc/en/trunk/reference/spl/parentiterator/accept.xml (rev 0)
+++ phpdoc/en/trunk/reference/spl/parentiterator/accept.xml 2009-10-08 15:38:13 UTC (rev 289348)
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="parentiterator.accept" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>ParentIterator::accept</refname>
+ <refpurpose>Determines acceptability</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier>
<type>bool</type><methodname>ParentIterator::accept</methodname>
+ <void />
+ </methodsynopsis>
+ <para>
+ Determines if the the current element has children.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ &true; if the current element is acceptable, otherwise &false;.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <para>
+ <simplelist>
+ <member><methodname>ParentIterator::hasChildren</methodname></member>
+ <member><methodname>FilterIterator::accept</methodname></member>
+ </simplelist>
+ </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
+-->
Property changes on: phpdoc/en/trunk/reference/spl/parentiterator/accept.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native
Added: phpdoc/en/trunk/reference/spl/parentiterator/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/spl/parentiterator/construct.xml (rev 0)
+++ phpdoc/en/trunk/reference/spl/parentiterator/construct.xml 2009-10-08 15:38:13 UTC (rev 289348)
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="parentiterator.construct" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>ParentIterator::__construct</refname>
+ <refpurpose>Constructs a ParentIterator</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <methodname>ParentIterator::__construct</methodname>
+
<methodparam><type>RecursiveIterator</type><parameter>iterator</parameter></methodparam>
+ </methodsynopsis>
+ <para>
+ Constructs a <classname>ParentIterator</classname> on an iterator.
+ </para>
+
+ &warn.undocumented.func;
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>iterator</parameter></term>
+ <listitem>
+ <para>
+ The iterator being constructed upon.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ The <classname>ParentIterator</classname>.
+ </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
+-->
Property changes on: phpdoc/en/trunk/reference/spl/parentiterator/construct.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision
Added: svn:eol-style
+ native