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

ID: 38237 Updated by: bjori@php.net Reported By: phpbugs at majiclab dot com Status: Assigned Bug Type: Documentation problem Operating System: n/a PHP Version: Irrelevant Assigned To: bjori New Comment: > 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 Previous Comments: ------------------------------------------------------------------------ [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. ------------------------------------------------------------------------ [2007-08-17 06:30:30] phpbugs at majiclab dot com Granted, but there doesn't seem to be any reference to any of them on that page itself? What envision being a LOT more user-friendly and intuitive is at the very top of that page, in the box that lists out all the classes, have the class name be a link to the anchor for that particular class. I don't find it easy to scroll through the page and find a particular class. ------------------------------------------------------------------------ [2007-08-17 05:51:19] sean@php.net There /are/ anchor tags. See: http://php.net/reflection#language.oop5.reflection.reflectionexception for example. S ------------------------------------------------------------------------ [2007-08-17 05:46:53] phpbugs at majiclab dot com I can accept #1, but as for #2, I agree long pages can be more practical... However, without anchor tags being used, it makes that one long page very unfriendly. It'd be great if you could add links at the top of the page that jump down to each class' section. ------------------------------------------------------------------------ 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