Reference spl recursiveiteratoriterator (#385)

* ajustes current de spl/recursiveiteratoriterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71 * ajustes em getdepth de spl/recursiveiteratoriterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71 * ajustes em getsubiterator de spl/recursiveiteratoriterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71 * ajustes em key de spl/recursiveiteratoriterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71 * ajustes em next de spl/recursiveiteratoriterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71 * ajustes rewind de spl/recursiveiteratoriterator conforme revisão em inglês em d51166ca16fda8e766849505b84f9306ef443f71
php · Dec 5, 2023 · ffa8ff2 · ffa8ff2
1 parent 1661d5f
commit ffa8ff2
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 39 deletions.
diff --git a/reference/spl/recursiveiteratoriterator/current.xml b/reference/spl/recursiveiteratoriterator/current.xml
@@ -1,15 +1,14 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: diogo, fernandowobeto -->
 <refentry xml:id="recursiveiteratoriterator.current" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>RecursiveIteratorIterator::current</refname>
   <refpurpose>Retorna o valor do elemento atual</refpurpose>
  </refnamediv>
-
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>mixed</type><methodname>RecursiveIteratorIterator::current</methodname>
+  <methodsynopsis role="RecursiveIteratorIterator">
+   <modifier>public</modifier> <type>mixed</type><methodname>RecursiveIteratorIterator::current</methodname>
    <void/>
   </methodsynopsis>
 
@@ -30,7 +29,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/recursiveiteratoriterator/getdepth.xml b/reference/spl/recursiveiteratoriterator/getdepth.xml
@@ -1,15 +1,14 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: diogo, fernandowobeto -->
 <refentry xml:id="recursiveiteratoriterator.getdepth" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>RecursiveIteratorIterator::getDepth</refname>
   <refpurpose>Retorna a profundidade atual da iteração recursiva</refpurpose>
  </refnamediv>
-
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>int</type><methodname>RecursiveIteratorIterator::getDepth</methodname>
+  <methodsynopsis role="RecursiveIteratorIterator">
+   <modifier>public</modifier> <type>int</type><methodname>RecursiveIteratorIterator::getDepth</methodname>
    <void/>
   </methodsynopsis>
 
@@ -30,7 +29,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/recursiveiteratoriterator/getsubiterator.xml b/reference/spl/recursiveiteratoriterator/getsubiterator.xml
@@ -1,16 +1,15 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: diogo, fernandowobeto -->
 <refentry xml:id="recursiveiteratoriterator.getsubiterator" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>RecursiveIteratorIterator::getSubIterator</refname>
   <refpurpose>Retorna o sub-iterador ativo atual</refpurpose>
  </refnamediv>
-
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>RecursiveIterator</type><methodname>RecursiveIteratorIterator::getSubIterator</methodname>
-   <void/>
+  <methodsynopsis role="RecursiveIteratorIterator">
+   <modifier>public</modifier> <type class="union"><type>RecursiveIterator</type><type>null</type></type><methodname>RecursiveIteratorIterator::getSubIterator</methodname>
+   <methodparam choice="opt"><type class="union"><type>int</type><type>null</type></type><parameter>level</parameter><initializer>&null;</initializer></methodparam>
   </methodsynopsis>
 
    &warn.undocumented.func;
@@ -19,18 +18,52 @@
 
  <refsect1 role="parameters">
   &reftitle.parameters;
-  &no.function.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>level</parameter></term>
+     <listitem>
+      <para>
+
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
  </refsect1>
 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   O atual sub-iterador ativo.
+   O atual sub-iterador ativo em caso de sucesso; &null; em caso de falha.
   </para>
  </refsect1>
 
-</refentry>
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <para>
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>8.0.0</entry>
+       <entry>
+        <parameter>level</parameter> agora é anulável
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </para>
+ </refsect1>
 
+</refentry>
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/recursiveiteratoriterator/key.xml b/reference/spl/recursiveiteratoriterator/key.xml
@@ -1,15 +1,14 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: diogo, fernandowobeto -->
 <refentry xml:id="recursiveiteratoriterator.key" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>RecursiveIteratorIterator::key</refname>
   <refpurpose>Retorna a chave atual</refpurpose>
  </refnamediv>
-
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>mixed</type><methodname>RecursiveIteratorIterator::key</methodname>
+  <methodsynopsis role="RecursiveIteratorIterator">
+   <modifier>public</modifier> <type>mixed</type><methodname>RecursiveIteratorIterator::key</methodname>
    <void/>
   </methodsynopsis>
 
@@ -30,7 +29,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/recursiveiteratoriterator/next.xml b/reference/spl/recursiveiteratoriterator/next.xml
@@ -1,15 +1,14 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: diogo, fernandowobeto -->
 <refentry xml:id="recursiveiteratoriterator.next" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>RecursiveIteratorIterator::next</refname>
   <refpurpose>Avança para o próximo elemento</refpurpose>
  </refnamediv>
-
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>void</type><methodname>RecursiveIteratorIterator::next</methodname>
+  <methodsynopsis role="RecursiveIteratorIterator">
+   <modifier>public</modifier> <type>void</type><methodname>RecursiveIteratorIterator::next</methodname>
    <void/>
   </methodsynopsis>
 
@@ -30,7 +29,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

diff --git a/reference/spl/recursiveiteratoriterator/rewind.xml b/reference/spl/recursiveiteratoriterator/rewind.xml
@@ -1,15 +1,14 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!-- EN-Revision: 2fd3f0c96d9d221fe37109775af4df4cf949d5d8 Maintainer: diogo Status: ready -->
+<?xml version="1.0" encoding="utf-8"?>
+<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: fernandowobeto Status: ready --><!-- CREDITS: diogo, fernandowobeto -->
 <refentry xml:id="recursiveiteratoriterator.rewind" xmlns="http://docbook.org/ns/docbook">
  <refnamediv>
   <refname>RecursiveIteratorIterator::rewind</refname>
   <refpurpose>Recomeça o iterador no primeiro elemento do primeiro iterador interno</refpurpose>
  </refnamediv>
-
  <refsect1 role="description">
   &reftitle.description;
-  <methodsynopsis>
-   <type>void</type><methodname>RecursiveIteratorIterator::rewind</methodname>
+  <methodsynopsis role="RecursiveIteratorIterator">
+   <modifier>public</modifier> <type>void</type><methodname>RecursiveIteratorIterator::rewind</methodname>
    <void/>
   </methodsynopsis>
 
@@ -30,7 +29,6 @@
  </refsect1>
 
 </refentry>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml