From 6803b3c62d52422181a74b1a9b4525f56abd098e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?M=C3=A1t=C3=A9=20Kocsis?= <kocsismate@woohoolabs.com>
Date: Thu, 23 Dec 2021 14:22:05 +0100
Subject: [PATCH] Generate various class synopses from stubs - part 1 (#1241)

---
 reference/reflection/reflectionfiber.xml  |  9 ++--
 reference/sem/sysvmessagequeue.xml        |  5 +-
 reference/sem/sysvsharedmemory.xml        |  5 +-
 reference/simplexml/simplexmlelement.xml  | 58 ++++++++++++++++++-----
 reference/simplexml/simplexmliterator.xml | 56 ++++++++++++----------
 5 files changed, 84 insertions(+), 49 deletions(-)

diff --git a/reference/reflection/reflectionfiber.xml b/reference/reflection/reflectionfiber.xml
index 66b50ca3dd..843a6096ec 100644
--- a/reference/reflection/reflectionfiber.xml
+++ b/reference/reflection/reflectionfiber.xml
@@ -19,16 +19,17 @@
 
 <!-- {{{ Synopsis -->
    <classsynopsis>
-    <ooclass><classname>ReflectionFiber</classname></ooclass>
+    <ooclass>
+     <classname>ReflectionFiber</classname>
+    </ooclass>
 
-<!-- {{{ Class synopsis -->
     <classsynopsisinfo>
      <ooclass>
+      <modifier>final</modifier>
       <classname>ReflectionFiber</classname>
      </ooclass>
     </classsynopsisinfo>
-<!-- }}} -->
-    
+
     <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionfiber')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
      <xi:fallback/>
diff --git a/reference/sem/sysvmessagequeue.xml b/reference/sem/sysvmessagequeue.xml
index b301590157..1a939e9d96 100644
--- a/reference/sem/sysvmessagequeue.xml
+++ b/reference/sem/sysvmessagequeue.xml
@@ -23,15 +23,12 @@
      <classname>SysvMessageQueue</classname>
     </ooclass>
 
-    <!-- {{{ Class synopsis -->
     <classsynopsisinfo>
      <ooclass>
       <modifier>final</modifier>
       <classname>SysvMessageQueue</classname>
      </ooclass>
     </classsynopsisinfo>
-    <!-- }}} -->
-
    </classsynopsis>
    <!-- }}} -->
 
@@ -40,7 +37,7 @@
  </partintro>
 
 </phpdoc:classref>
- <!-- Keep this comment at the end of the file
+<!-- Keep this comment at the end of the file
  Local variables:
  mode: sgml
  sgml-omittag:t
diff --git a/reference/sem/sysvsharedmemory.xml b/reference/sem/sysvsharedmemory.xml
index 9cd1633c18..348d8f925d 100644
--- a/reference/sem/sysvsharedmemory.xml
+++ b/reference/sem/sysvsharedmemory.xml
@@ -23,15 +23,12 @@
      <classname>SysvSharedMemory</classname>
     </ooclass>
 
-    <!-- {{{ Class synopsis -->
     <classsynopsisinfo>
      <ooclass>
       <modifier>final</modifier>
       <classname>SysvSharedMemory</classname>
      </ooclass>
     </classsynopsisinfo>
-    <!-- }}} -->
-
    </classsynopsis>
    <!-- }}} -->
 
@@ -40,7 +37,7 @@
  </partintro>
 
 </phpdoc:classref>
- <!-- Keep this comment at the end of the file
+<!-- Keep this comment at the end of the file
  Local variables:
  mode: sgml
  sgml-omittag:t
diff --git a/reference/simplexml/simplexmlelement.xml b/reference/simplexml/simplexmlelement.xml
index 6fd087b954..d665350849 100644
--- a/reference/simplexml/simplexmlelement.xml
+++ b/reference/simplexml/simplexmlelement.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.simplexmlelement" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<phpdoc:classref xml:id="class.simplexmlelement" 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 SimpleXMLElement class</title>
  <titleabbrev>SimpleXMLElement</titleabbrev>
  
@@ -20,34 +20,70 @@
  
 <!-- {{{ Synopsis -->
    <classsynopsis>
-    <ooclass><classname>SimpleXMLElement</classname></ooclass>
- 
-<!-- {{{ Class synopsis -->
+    <ooclass>
+     <classname>SimpleXMLElement</classname>
+    </ooclass>
+
     <classsynopsisinfo>
      <ooclass>
       <classname>SimpleXMLElement</classname>
      </ooclass>
-     
+
      <oointerface>
-      <interfacename>Traversable</interfacename>
+      <interfacename>Stringable</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>Countable</interfacename>
+     </oointerface>
+
+     <oointerface>
+      <interfacename>RecursiveIterator</interfacename>
      </oointerface>
     </classsynopsisinfo>
-<!-- }}} -->
- 
+
     <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmlelement')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmlelement')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmlelement')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
+     <xi:fallback/>
+    </xi:include>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmlelement')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
+     <xi:fallback/>
+    </xi:include>
    </classsynopsis>
 <!-- }}} -->
  
   </section>
+
+  <section role="changelog">
+   &reftitle.changelog;
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>8.0.0</entry>
+       <entry>
+        <classname>SimpleXMLElement</classname> implements
+        <interfacename>Stringable</interfacename>,
+        <interfacename>Countable</interfacename>,
+        and <interfacename>RecursiveIterator</interfacename> now.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </section>
  
  </partintro>
  
  &reference.simplexml.entities.simplexmlelement;
 
 </phpdoc:classref>
- 
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
diff --git a/reference/simplexml/simplexmliterator.xml b/reference/simplexml/simplexmliterator.xml
index 6707b14b81..24e06efbc1 100644
--- a/reference/simplexml/simplexmliterator.xml
+++ b/reference/simplexml/simplexmliterator.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.simplexmliterator" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<phpdoc:classref xml:id="class.simplexmliterator" 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 SimpleXMLIterator class</title>
  <titleabbrev>SimpleXMLIterator</titleabbrev>
 
@@ -20,9 +20,10 @@
 
 <!-- {{{ Synopsis -->
    <classsynopsis>
-    <ooclass><classname>SimpleXMLIterator</classname></ooclass>
+    <ooclass>
+     <classname>SimpleXMLIterator</classname>
+    </ooclass>
 
-<!-- {{{ Class synopsis -->
     <classsynopsisinfo>
      <ooclass>
       <classname>SimpleXMLIterator</classname>
@@ -32,33 +33,15 @@
       <modifier>extends</modifier>
       <classname>SimpleXMLElement</classname>
      </ooclass>
-
-     <oointerface>
-      <interfacename>RecursiveIterator</interfacename>
-     </oointerface>
-
-     <oointerface>
-      <interfacename>Countable</interfacename>
-     </oointerface>
-
     </classsynopsisinfo>
-<!-- }}} -->
-
-    <!-- {{{ If the property is documented below (xml:id=simplexmliterator.props) use this
-    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
-    <fieldsynopsis>
-     <modifier>public</modifier>
-     <type>string</type>
-     <varname linkend="simplexmliterator.props.name">name</varname>
-    </fieldsynopsis>
-    }}} -->
 
     <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
     <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmliterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
 
     <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmlelement')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmlelement')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.simplexmlelement')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
+     <xi:fallback/>
+    </xi:include>
    </classsynopsis>
 
   </section>
@@ -77,12 +60,34 @@
   </section>
 }}} -->
 
+  <section role="changelog">
+   &reftitle.changelog;
+   <informaltable>
+    <tgroup cols="2">
+     <thead>
+      <row>
+       <entry>&Version;</entry>
+       <entry>&Description;</entry>
+      </row>
+     </thead>
+     <tbody>
+      <row>
+       <entry>8.0.0</entry>
+       <entry>
+        <classname>SimpleXMLIterator</classname> implements
+        <interfacename>Stringable</interfacename> now.
+       </entry>
+      </row>
+     </tbody>
+    </tgroup>
+   </informaltable>
+  </section>
+
  </partintro>
 
  &reference.simplexml.entities.simplexmliterator;
 
 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
@@ -103,4 +108,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
 vim: et tw=78 syn=sgml
 vi: ts=1 sw=1
 -->
-