Bug #52314 [Opn->Csd]: Incorrect use of classsynopsisinfo

Edit report at https://bugs.php.net/bug.php?id=52314&edit=1 ID: 52314 Updated by: bjori@php.net Reported by: RQuadling at GMail dot com Summary: Incorrect use of classsynopsisinfo -Status: Open +Status: Closed Type: Bug Package: Doc Build problem Operating System: n/a PHP Version: Irrelevant -Assigned To: +Assigned To: bjori Block user comment: N Private report: N New Comment: This was fixed a while ago Previous Comments: ------------------------------------------------------------------------ [2010-07-12 12:17:13] RQuadling at GMail dot com Description: ------------ Looking at most of the OOP class pages ... 3 chosen at random : http://docs.php.net/manual/en/class.Phar.php http://docs.php.net/manual/en/class.datetime.php http://docs.php.net/manual/en/class.arrayobject.php There is an empty white box at the top of the class definition. The issue seems to be due to the first ooclass tag which isn't rendered properly. The xml also has ooclass and oointerface tags inside an classsynopsisinfo. This seems to be against the intent of a classsynopsisinfo. TDG5 (http://www.docbook.org/tdg51/en/html/classsynopsisinfo.html) says "Supplementary information in a classsynopsis. See classsynopsis. Unlike the other info elements, classsynopsisinfo is not a container for meta- information. Instead classsynopsisinfo is a verbatim environment for adding additional information to a class synopsis." Also important on this is the processing expectations which are "This element is displayed “verbatim”; whitespace and line breaks within this element are significant.". What exactly warrants "Supplementary information" is the issue here. DocBook has tags for ooclass and oointerface (and these are in the "1 or more of" sequence for classsynopsis) and so have no need to be thought of as "supplementary information". Using classsynopsisinfo to show comments (/* Methods */, /* Constants */, etc.) would seem to fit the spirit of this tag. So ... <!-- {{{ Synopsis --> <classsynopsis> <ooclass><classname>DateTimeZone</classname></ooclass> <!-- {{{ Class synopsis --> <classsynopsisinfo> <ooclass> <classname>DateTimeZone</classname> </ooclass> </classsynopsisinfo> <!-- }}} --> <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo> <fieldsynopsis> <modifier>const</modifier> <type>integer</type> should be ... <!-- {{{ Synopsis --> <classsynopsis> <ooclass><classname>DateTimeZone</classname></ooclass> <!-- }}} --> <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo> <fieldsynopsis> <modifier>const</modifier> <type>integer</type> No need for the classsynopsisinfo with the ooclass tags. ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=52314&edit=1