#38237 [Asn->Csd]: Add PHP5 Reflection* Class documentation to main "Function Reference" docs

From: Date: Mon, 17 Sep 2007 12:50:11 +0000
Subject: #38237 [Asn->Csd]: Add PHP5 Reflection* Class documentation to main "Function Reference" docs
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-14@lists.php.net to get a copy of this message
ID: 38237 Updated by: bjori@php.net Reported By: phpbugs at majiclab dot com -Status: Assigned +Status: Closed Bug Type: Documentation problem Operating System: n/a PHP Version: Irrelevant Assigned To: bjori New Comment: This bug has been fixed in the documentation's XML sources. Since the online and downloadable versions of the documentation need some time to get updated, we would like to ask you to be a bit patient. Thank you for the report, and for helping us make our documentation better. Added homemade TOC on the top. Regarding moving these docs to the 'Function Reference', that will happen when we have redesigned our index (see bug#39083). Previous Comments: ------------------------------------------------------------------------ [2007-08-23 02:10:46] philip@php.net Sounds good, go for it. ------------------------------------------------------------------------ [2007-08-17 13:13:40] bjori@php.net ..but we could create our own home made TOC with something like: <simplelist> <member><xref linkend="reflection.introduction" /></member> <member><xref linkend="reflection.reflectionexception" /></member> <member><xref linkend="reflection.reflectionparameter" /></member> ... </simplelist> Feels really dirty but it will get the job done until we refactor these docs. Philip: what do you think? ------------------------------------------------------------------------ [2007-08-17 13:09:24] bjori@php.net > Are you saying the current build system can't > handle the changes I suggested to the HTML? That is exactly what I am saying. This is a limitation in the DocBook-XSL stylesheets. > I just went to quickly find something that > behaves similarly to what I would expect: > > http://ca.php.net/manual/en/language.functions.php These two pages use totally different markup, not even remotely close. And no. We cannot use this markup for reflection. -Hannes ------------------------------------------------------------------------ [2007-08-17 12:51:26] phpbugs at majiclab dot com @bjori: Are you saying the current build system can't handle the changes I suggested to the HTML? I just went to quickly find something that behaves similarly to what I would expect: http://ca.php.net/manual/en/language.functions.php On this page, at the top it has a TOC, and the first link goes down to an anchor on the page. Maybe it can't be put in the box with all the class names I mentioned, but can't there be a TOC at least? ------------------------------------------------------------------------ [2007-08-17 09:42:17] bjori@php.net I agree, but this won't change using the current build system. I also think we should refactor those docs into the funcref where all other extensions are documented. The main problem here is the fact our OO docs simply suck and I am looking into how we can make them better. ------------------------------------------------------------------------ The remainder of the comments for this report are too long. To view the rest of the comments, please view the bug report online at http://bugs.php.net/38237 -- Edit this bug report at http://bugs.php.net/?id=38237&edit=1

« previous php.doc.bugs (#14) next »