Doc #52314 [NEW]: Incorrect use of classsynopsisinfo

From: Operating system: n/a PHP version: Irrelevant Package: Doc Build problem Bug Type: Documentation Problem Bug description:Incorrect use of classsynopsisinfo 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 bug report at http://bugs.php.net/bug.php?id=52314&edit=1 -- Try a snapshot (PHP 5.2): http://bugs.php.net/fix.php?id=52314&r=trysnapshot52 Try a snapshot (PHP 5.3): http://bugs.php.net/fix.php?id=52314&r=trysnapshot53 Try a snapshot (trunk): http://bugs.php.net/fix.php?id=52314&r=trysnapshottrunk Fixed in SVN: http://bugs.php.net/fix.php?id=52314&r=fixed Fixed in SVN and need be documented: http://bugs.php.net/fix.php?id=52314&r=needdocs Fixed in release: http://bugs.php.net/fix.php?id=52314&r=alreadyfixed Need backtrace: http://bugs.php.net/fix.php?id=52314&r=needtrace Need Reproduce Script: http://bugs.php.net/fix.php?id=52314&r=needscript Try newer version: http://bugs.php.net/fix.php?id=52314&r=oldversion Not developer issue: http://bugs.php.net/fix.php?id=52314&r=support Expected behavior: http://bugs.php.net/fix.php?id=52314&r=notwrong Not enough info: http://bugs.php.net/fix.php?id=52314&r=notenoughinfo Submitted twice: http://bugs.php.net/fix.php?id=52314&r=submittedtwice register_globals: http://bugs.php.net/fix.php?id=52314&r=globals PHP 4 support discontinued: http://bugs.php.net/fix.php?id=52314&r=php4 Daylight Savings: http://bugs.php.net/fix.php?id=52314&r=dst IIS Stability: http://bugs.php.net/fix.php?id=52314&r=isapi Install GNU Sed: http://bugs.php.net/fix.php?id=52314&r=gnused Floating point limitations: http://bugs.php.net/fix.php?id=52314&r=float No Zend Extensions: http://bugs.php.net/fix.php?id=52314&r=nozend MySQL Configuration Error: http://bugs.php.net/fix.php?id=52314&r=mysqlcfg