Generate ext/reflection class synopses from stubs - part 1 (#1120)

2026-03-24 07:42:10 +01:00 · 2021-11-23 14:15:35 +01:00
parent 470a17d5e8
commit b0c0d6bcd9
6 changed files with 60 additions and 64 deletions
--- a/reference/reflection/reflectionparameter.xml
+++ b/reference/reflection/reflectionparameter.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <phpdoc:classref xml:id="class.reflectionparameter" 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 ReflectionParameter class</title>
@@ -30,31 +29,34 @@

 <!-- {{{ Synopsis -->
   <classsynopsis>
-    <ooclass><classname>ReflectionParameter</classname></ooclass>
+    <ooclass>
+     <classname>ReflectionParameter</classname>
+    </ooclass>

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>ReflectionParameter</classname>
     </ooclass>
-     
+
     <oointerface>
      <interfacename>Reflector</interfacename>
     </oointerface>
    </classsynopsisinfo>
-<!-- }}} -->
+
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
+     <type>string</type>
     <varname linkend="reflectionparameter.props.name">name</varname>
    </fieldsynopsis>

-    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionparameter')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
+    </xi:include>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionparameter')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
+     <xi:fallback/>
    </xi:include>
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionparameter')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
 <!-- }}} -->

@@ -84,7 +86,6 @@
 &reference.reflection.entities.reflectionparameter;

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
--- a/reference/reflection/reflectionproperty.xml
+++ b/reference/reflection/reflectionproperty.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <phpdoc:classref xml:id="class.reflectionproperty" 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 ReflectionProperty class</title>
@@ -23,14 +22,15 @@

 <!-- {{{ Synopsis -->
   <classsynopsis>
-    <ooclass><classname>ReflectionProperty</classname></ooclass>
+    <ooclass>
+     <classname>ReflectionProperty</classname>
+    </ooclass>

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>ReflectionProperty</classname>
     </ooclass>
-     
+
     <oointerface>
      <interfacename>Reflector</interfacename>
     </oointerface>
@@ -65,19 +65,22 @@
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
+     <type>string</type>
     <varname linkend="reflectionproperty.props.name">name</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
+     <type>string</type>
     <varname linkend="reflectionproperty.props.class">class</varname>
    </fieldsynopsis>

-    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionproperty')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
+    </xi:include>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionproperty')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
+     <xi:fallback/>
    </xi:include>
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionproperty')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
 <!-- }}} -->

@@ -180,7 +183,6 @@
 &reference.reflection.entities.reflectionproperty;

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
--- a/reference/reflection/reflectionreference.xml
+++ b/reference/reflection/reflectionreference.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <phpdoc:classref xml:id="class.reflectionreference" 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 ReflectionReference class</title>
@@ -23,24 +22,23 @@

 <!-- {{{ Synopsis -->
   <classsynopsis>
-    <ooclass><classname>ReflectionReference</classname></ooclass>
+    <ooclass>
+     <classname>ReflectionReference</classname>
+    </ooclass>

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
-      <modifier>final</modifier> <classname>ReflectionReference</classname>
+      <modifier>final</modifier>
+      <classname>ReflectionReference</classname>
     </ooclass>
    </classsynopsisinfo>
-<!-- }}} -->
-    
+
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
-    <!--
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionreference')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
    </xi:include>
-    -->
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionreference')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
    </xi:include>
   </classsynopsis>
 <!-- }}} -->
@@ -52,7 +50,6 @@
 &reference.reflection.entities.reflectionreference;

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
--- a/reference/reflection/reflectiontype.xml
+++ b/reference/reflection/reflectiontype.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <phpdoc:classref xml:id="class.reflectiontype" 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 ReflectionType class</title>
@@ -28,26 +27,25 @@

 <!-- {{{ Synopsis -->
   <classsynopsis>
-    <ooclass><classname>ReflectionType</classname></ooclass>
+    <ooclass>
+     <classname>ReflectionType</classname>
+    </ooclass>

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <modifier>abstract</modifier>
      <classname>ReflectionType</classname>
     </ooclass>
-    </classsynopsisinfo>
-<!-- }}} -->
-    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
-    <!--
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectiontype')/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.reflectiontype')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])">
-     <xi:fallback />
-    </xi:include>

+     <oointerface>
+      <interfacename>Stringable</interfacename>
+     </oointerface>
+    </classsynopsisinfo>
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectiontype')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
+     <xi:fallback/>
+    </xi:include>
   </classsynopsis>
 <!-- }}} -->
  </section>
@@ -82,7 +80,6 @@
 &reference.reflection.entities.reflectiontype;

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
--- a/reference/reflection/reflectionuniontype.xml
+++ b/reference/reflection/reflectionuniontype.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <phpdoc:classref xml:id="class.reflectionuniontype" 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 ReflectionUnionType class</title>
@@ -22,30 +21,30 @@

 <!-- {{{ Synopsis -->
   <classsynopsis>
-    <ooclass><classname>ReflectionUnionType</classname></ooclass>
+    <ooclass>
+     <classname>ReflectionUnionType</classname>
+    </ooclass>

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>ReflectionUnionType</classname>
     </ooclass>
-     
+
     <ooclass>
      <modifier>extends</modifier>
      <classname>ReflectionType</classname>
     </ooclass>
    </classsynopsisinfo>
-<!-- }}} -->
-    
+
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionuniontype')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
-     <xi:fallback />
-    </xi:include>
-    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectiontype')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
    </xi:include>

+    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectiontype')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
+     <xi:fallback/>
+    </xi:include>
   </classsynopsis>
 <!-- }}} -->

@@ -56,7 +55,6 @@
 &reference.reflection.entities.reflectionuniontype;

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
--- a/reference/reflection/reflectionzendextension.xml
+++ b/reference/reflection/reflectionzendextension.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <phpdoc:classref xml:id="class.reflectionzendextension" 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 ReflectionZendExtension class</title>
@@ -22,31 +21,34 @@

 <!-- {{{ Synopsis -->
   <classsynopsis>
-    <ooclass><classname>ReflectionZendExtension</classname></ooclass>
+    <ooclass>
+     <classname>ReflectionZendExtension</classname>
+    </ooclass>

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>ReflectionZendExtension</classname>
     </ooclass>
-     
+
     <oointerface>
      <interfacename>Reflector</interfacename>
     </oointerface>
    </classsynopsisinfo>
-<!-- }}} -->
+
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
+     <type>string</type>
     <varname linkend="reflectionzendextension.props.name">name</varname>
    </fieldsynopsis>

-    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionzendextension')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
+    </xi:include>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionzendextension')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
+     <xi:fallback/>
    </xi:include>
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.reflectionzendextension')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
   </classsynopsis>
 <!-- }}} -->

@@ -76,7 +78,6 @@
 &reference.reflection.entities.reflectionzendextension;

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml