sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-15 08:28:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Generate ext/spl class synopses from stubs - part 2 (#1223)

Browse source
This commit is contained in:
Máté Kocsis 2021-12-21 14:21:47 +01:00 committed by GitHub
parent 9eb4ef92af
commit 455d218f86
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 58 additions and 113 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
reference/spl/splheap.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.splheap" 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.splheap" 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 SplHeap class</title>
<titleabbrev>SplHeap</titleabbrev>
@ -20,13 +20,14 @@
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SplHeap</classname></ooclass>
<!-- {{{ Class synopsis -->
<ooclass>
<classname>SplHeap</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
<modifier>abstract</modifier> <classname>SplHeap</classname>
<modifier>abstract</modifier>
<classname>SplHeap</classname>
</ooclass>
<oointerface>
@ -36,22 +37,13 @@
<oointerface>
<interfacename>Countable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<!-- {{{ If the property is documented below (xml:id=splheap.props) use this
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="splheap.props.name">name</varname>
</fieldsynopsis>
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splheap')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splheap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splheap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
@ -75,7 +67,6 @@
&reference.spl.entities.splheap;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -96,4 +87,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

39
reference/spl/splmaxheap.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.splmaxheap" 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.splmaxheap" 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 SplMaxHeap class</title>
<titleabbrev>SplMaxHeap</titleabbrev>
@ -20,9 +20,9 @@
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SplMaxHeap</classname></ooclass>
<!-- {{{ Class synopsis -->
<ooclass>
<classname>SplMaxHeap</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
@ -33,32 +33,17 @@
<modifier>extends</modifier>
<classname>SplHeap</classname>
</ooclass>
<oointerface>
<interfacename>Iterator</interfacename>
</oointerface>
<oointerface>
<interfacename>Countable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<!-- {{{ If the property is documented below (xml:id=splmaxheap.props) use this
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="splmaxheap.props.name">name</varname>
</fieldsynopsis>
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splmaxheap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splmaxheap')/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.splheap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splheap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
@ -83,7 +68,6 @@
&reference.spl.entities.splmaxheap;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -104,4 +88,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

39
reference/spl/splminheap.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.splminheap" 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.splminheap" 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 SplMinHeap class</title>
<titleabbrev>SplMinHeap</titleabbrev>
@ -20,9 +20,9 @@
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SplMinHeap</classname></ooclass>
<!-- {{{ Class synopsis -->
<ooclass>
<classname>SplMinHeap</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
@ -33,32 +33,17 @@
<modifier>extends</modifier>
<classname>SplHeap</classname>
</ooclass>
<oointerface>
<interfacename>Iterator</interfacename>
</oointerface>
<oointerface>
<interfacename>Countable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<!-- {{{ If the property is documented below (xml:id=splminheap.props) use this
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="splminheap.props.name">name</varname>
</fieldsynopsis>
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splminheap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splminheap')/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.splheap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splheap')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
@ -83,7 +68,6 @@
&reference.spl.entities.splminheap;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -104,4 +88,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->

16
reference/spl/splobjectstorage.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.splobjectstorage" 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 SplObjectStorage class</title>
@ -24,14 +23,15 @@
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SplObjectStorage</classname></ooclass>
<ooclass>
<classname>SplObjectStorage</classname>
</ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>SplObjectStorage</classname>
</ooclass>
<oointerface>
<interfacename>Countable</interfacename>
</oointerface>
@ -48,10 +48,11 @@
<interfacename>ArrayAccess</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splobjectstorage')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splobjectstorage')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
@ -144,7 +145,6 @@ array(3) {
&reference.spl.entities.splobjectstorage;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

20
reference/spl/splobserver.xml
View file

@ -1,6 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.splobserver" 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 SplObserver interface</title>
@ -23,18 +22,20 @@
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SplObserver</classname></ooclass>
<ooclass>
<classname>SplObserver</classname>
</ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>SplObserver</classname>
</ooclass>
<oointerface>
<interfacename>SplObserver</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splobserver')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splobserver')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
<!-- }}} -->
@ -45,7 +46,6 @@
&reference.spl.entities.splobserver;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml

27
reference/spl/splpriorityqueue.xml
View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.splpriorityqueue" 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.splpriorityqueue" 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 SplPriorityQueue class</title>
<titleabbrev>SplPriorityQueue</titleabbrev>
@ -27,9 +27,9 @@
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>SplPriorityQueue</classname></ooclass>
<!-- {{{ Class synopsis -->
<ooclass>
<classname>SplPriorityQueue</classname>
</ooclass>
<classsynopsisinfo>
<ooclass>
@ -43,22 +43,13 @@
<oointerface>
<interfacename>Countable</interfacename>
</oointerface>
</classsynopsisinfo>
<!-- }}} -->
<!-- {{{ If the property is documented below (xml:id=splpriorityqueue.props) use this
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<type>string</type>
<varname linkend="splpriorityqueue.props.name">name</varname>
</fieldsynopsis>
}}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splpriorityqueue')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splpriorityqueue')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.splpriorityqueue')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
<xi:fallback/>
</xi:include>
</classsynopsis>
</section>
@ -82,7 +73,6 @@
&reference.spl.entities.splpriorityqueue;
</phpdoc:classref>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@ -103,4 +93,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->