Generate ext/com_dotnet class synopses from stubs

Closes GH-1064.
2026-03-25 08:12:15 +01:00 · 2021-11-08 16:15:00 +01:00
parent 8d8cd43bfc
commit bd8169a9b1
5 changed files with 38 additions and 56 deletions
--- a/reference/com/com-exception.xml
+++ b/reference/com/com-exception.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <phpdoc:classref xml:id="class.com-exception" 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 com_exception class</title>
@@ -22,11 +21,13 @@

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

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
+      <modifier>final</modifier>
      <classname>com_exception</classname>
     </ooclass>

@@ -34,28 +35,17 @@
      <modifier>extends</modifier>
      <classname>Exception</classname>
     </ooclass>
-
-     <oointerface>
-      <interfacename>Throwable</interfacename>
-     </oointerface>
    </classsynopsisinfo>
-<!-- }}} -->
+
    <classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)">
-     <xi:fallback />
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:partintro/db:section/db:classsynopsis/db:fieldsynopsis[preceding-sibling::db:classsynopsisinfo[1][@role='comment' and text()='&Properties;']]))">
+     <xi:fallback/>
    </xi:include>

-<!-- Comment this section out if the exception does not contain any methods --><!--
-    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
-    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.com-exception')/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.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
    </xi:include>
-
   </classsynopsis>
 <!-- }}} -->

@@ -68,7 +58,6 @@
 -->

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
--- a/reference/com/com.xml
+++ b/reference/com/com.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
 <!-- splitted from ./en/functions/com.xml, last change in rev 1.12 -->
-<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.com" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
+<phpdoc:classref xml:id="class.com" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <titleabbrev>com</titleabbrev>
 <title>The com class</title>
 <partintro>
@@ -21,25 +21,24 @@

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

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>com</classname>
     </ooclass>

-    <ooclass>
-     <modifier>extends</modifier>
-     <classname>variant</classname>
-    </ooclass>
-
+     <ooclass>
+      <modifier>extends</modifier>
+      <classname>variant</classname>
+     </ooclass>
    </classsynopsisinfo>
-<!-- }}} -->

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.com')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
    </xi:include>
   </classsynopsis>
 <!-- }}} -->
@@ -142,7 +141,6 @@ $conn = null;
 &reference.com.entities.com;

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
--- a/reference/com/compersisthelper.xml
+++ b/reference/com/compersisthelper.xml
@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <phpdoc:classref xml:id="class.compersisthelper" 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 COMPersistHelper class</title>
@@ -13,7 +12,7 @@
   &reftitle.intro;
   <para>
    <classname>COMPersistHelper</classname> improves the interoperability of <acronym>COM</acronym>
-    and <acronym>PHP</acronym> with regard to the &php.ini; directive <link linkend='ini.open-basedir'>open_basedir</link>,
+    and <acronym>PHP</acronym> with regard to the &php.ini; directive <link linkend="ini.open-basedir">open_basedir</link>,
    and stream &resource;s.
   </para>
  </section>
@@ -24,23 +23,23 @@

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

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

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
--- a/reference/com/dotnet.xml
+++ b/reference/com/dotnet.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.dotnet" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink">
+<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="class.dotnet">
 <titleabbrev>dotnet</titleabbrev>
 <title>The dotnet class</title>
 <partintro>
@@ -41,25 +41,24 @@

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

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>dotnet</classname>
     </ooclass>

-    <ooclass>
-     <modifier>extends</modifier>
-     <classname>variant</classname>
-    </ooclass>
-
+     <ooclass>
+      <modifier>extends</modifier>
+      <classname>variant</classname>
+     </ooclass>
    </classsynopsisinfo>
-<!-- }}} -->

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.dotnet')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
    </xi:include>
   </classsynopsis>
 <!-- }}} -->
@@ -105,7 +104,6 @@ echo $stack->Pop() . $stack->Pop();
 &reference.com.entities.dotnet;

 </phpdoc:classref>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml
--- a/reference/com/variant.xml
+++ b/reference/com/variant.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.variant" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
+<phpdoc:classref xml:id="class.variant" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
 <titleabbrev>variant</titleabbrev>
 <title>variant class</title>
 <partintro>
@@ -22,19 +22,19 @@

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

-<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>variant</classname>
     </ooclass>
    </classsynopsisinfo>
-<!-- }}} -->

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.variant')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])">
-     <xi:fallback />
+     <xi:fallback/>
    </xi:include>
   </classsynopsis>
 <!-- }}} -->
@@ -81,7 +81,6 @@ print "The value is " . $v . "<br/>";
 &reference.com.entities.variant;

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