archive/php-src
1
0
Fork 0
mirror of https://github.com/php/php-src.git synced 2025-08-16 05:58:45 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

[skip ci] gen_stub: Use simpara by default instead of para tags for documentation

Browse source
This commit is contained in:
Gina Peter Banyard 2024-10-22 15:18:36 +01:00
parent e05b56fdb1
commit 32789c0047
No known key found for this signature in database
GPG key ID: 3306078E3194AEBD
1 changed files with 8 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

16
build/gen_stub.php
View file

@ -1686,7 +1686,7 @@ class FuncInfo {
$undocumentedEntity = $doc->createEntityReference('warn.undocumented.func'); $undocumentedEntity = $doc->createEntityReference('warn.undocumented.func');
$descriptionRefSec->appendChild($undocumentedEntity); $descriptionRefSec->appendChild($undocumentedEntity);
$descriptionRefSec->appendChild(new DOMText("\n ")); $descriptionRefSec->appendChild(new DOMText("\n "));
$returnDescriptionPara = $doc->createElement('para'); $returnDescriptionPara = $doc->createElement('simpara');
$returnDescriptionPara->appendChild(new DOMText("\n Description.\n ")); $returnDescriptionPara->appendChild(new DOMText("\n Description.\n "));
$descriptionRefSec->appendChild($returnDescriptionPara); $descriptionRefSec->appendChild($returnDescriptionPara);
@ -1709,7 +1709,7 @@ class FuncInfo {
$errorsDescriptionParaConstantTag->append('E_*'); $errorsDescriptionParaConstantTag->append('E_*');
$errorsDescriptionParaExceptionTag = $doc->createElement('exceptionname'); $errorsDescriptionParaExceptionTag = $doc->createElement('exceptionname');
$errorsDescriptionParaExceptionTag->append('Exception'); $errorsDescriptionParaExceptionTag->append('Exception');
$errorsDescriptionPara = $doc->createElement('para'); $errorsDescriptionPara = $doc->createElement('simpara');
$errorsDescriptionPara->append( $errorsDescriptionPara->append(
"\n When does this function issue ", "\n When does this function issue ",
$errorsDescriptionParaConstantTag, $errorsDescriptionParaConstantTag,
@ -1813,7 +1813,7 @@ ENDCOMMENT
$parametersRefSec->appendChild($noParamEntity); $parametersRefSec->appendChild($noParamEntity);
return $parametersRefSec; return $parametersRefSec;
} else { } else {
$parametersPara = $doc->createElement('para'); $parametersPara = $doc->createElement('simpara');
$parametersRefSec->appendChild($parametersPara); $parametersRefSec->appendChild($parametersPara);
$parametersPara->appendChild(new DOMText("\n ")); $parametersPara->appendChild(new DOMText("\n "));
@ -1824,9 +1824,9 @@ ENDCOMMENT
<varlistentry> <varlistentry>
<term><parameter>name</parameter></term> <term><parameter>name</parameter></term>
<listitem> <listitem>
<para> <simpara>
Description. Description.
</para> </simpara>
</listitem> </listitem>
</varlistentry> </varlistentry>
*/ */
@ -1835,7 +1835,7 @@ ENDCOMMENT
$parameterTerm = $doc->createElement('term'); $parameterTerm = $doc->createElement('term');
$parameterTerm->appendChild($parameter); $parameterTerm->appendChild($parameter);
$listItemPara = $doc->createElement('para'); $listItemPara = $doc->createElement('simpara');
$listItemPara->append( $listItemPara->append(
"\n ", "\n ",
"Description.", "Description.",
@ -1871,7 +1871,7 @@ ENDCOMMENT
private function getReturnValueSection(DOMDocument $doc): DOMElement { private function getReturnValueSection(DOMDocument $doc): DOMElement {
$returnRefSec = $this->generateRefSect1($doc, 'returnvalues'); $returnRefSec = $this->generateRefSect1($doc, 'returnvalues');
$returnDescriptionPara = $doc->createElement('para'); $returnDescriptionPara = $doc->createElement('simpara');
$returnDescriptionPara->appendChild(new DOMText("\n ")); $returnDescriptionPara->appendChild(new DOMText("\n "));
$returnType = $this->return->getMethodSynopsisType(); $returnType = $this->return->getMethodSynopsisType();
@ -2010,7 +2010,7 @@ ENDCOMMENT
$example->append("\n ", $title); $example->append("\n ", $title);
$para = $doc->createElement('para'); $para = $doc->createElement('simpara');
$para->append("\n ", "Description.", "\n "); $para->append("\n ", "Description.", "\n ");
$example->append("\n ", $para); $example->append("\n ", $para);