Skip to content

Commit 4ff6496

Browse files
committed
Generate a basic See Also section
1 parent 4266e57 commit 4ff6496

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

build/gen_stub.php

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1580,8 +1580,37 @@ public function getMethodSynopsisDocument(array $funcMap, array $aliasMap): ?str
15801580
/* Creation of <refsect1 role="changelog"> */
15811581
$changelogRefSec = $this->getChangelogSection($doc);
15821582
$refentry->appendChild($changelogRefSec);
1583+
$refentry->appendChild(new DOMText("\n\n "));
15831584

1584-
// TODO Examples, Notes, and See Also sections
1585+
// TODO Examples, and Notes sections
1586+
1587+
/* Creation of <refsect1 role="seealso"> */
1588+
$seeAlsoRefSec = $doc->createElement('refsect1');
1589+
$seeAlsoRefSec->setAttribute('role', 'seealso');
1590+
$seeAlsoRefSec->appendChild(new DOMText("\n "));
1591+
$refTitleSeeAlso = $doc->createEntityReference('reftitle.seealso');
1592+
$seeAlsoRefSec->appendChild($refTitleSeeAlso);
1593+
$seeAlsoRefSec->appendChild(new DOMText("\n "));
1594+
1595+
/* TODO Actually generate a markup for class names, functions and links?
1596+
<simplelist>
1597+
<member><methodname>ClassName::otherMethodName</methodname></member>
1598+
<member><function>some_function</function></member>
1599+
<member>The <link linkend="something">something appendix</link></member>
1600+
</simplelist>
1601+
*/
1602+
$seeAlsoMember = $doc->createElement('member');
1603+
$seeAlsoMember->appendChild(new DOMText("Method name, function, or link to reference"));
1604+
1605+
$seeAlsoList = $doc->createElement('simplelist');
1606+
$seeAlsoList->appendChild(new DOMText("\n "));
1607+
$seeAlsoList->appendChild($seeAlsoMember);
1608+
$seeAlsoList->appendChild(new DOMText("\n "));
1609+
1610+
$seeAlsoRefSec->appendChild($seeAlsoList);
1611+
$seeAlsoRefSec->appendChild(new DOMText("\n "));
1612+
1613+
$refentry->appendChild($seeAlsoRefSec);
15851614

15861615
$refentry->appendChild(new DOMText("\n\n"));
15871616

0 commit comments

Comments
 (0)