Actually we are thinking in a big change on PEAR::PHPDoc because no one
seems to understand it and it has serious problems with speed and other
bugs.
One idea is to replace PHPDoc with phpDocumentor (http://www.phpdoc.org)
for some reasons: it has more maintainers, a how-to, user manual and
other things that are missing on PEAR::PHPDoc.
I already started this thread some months ago and now we will finally
decide what to do. That will depend on what phpDocumentor developers
think about all this. =)
Ok, finally got round to make the prototype work.. - using my PHP_CodeDoc,
example generated HTML manual :
http://docs.akbkhome.com/docbook_gentest/
docbook xml files source generated
http://docs.akbkhome.com/test_docbook/docbook/
there are a few issues in doing this:
some packages have API's which are not in the main File, (not unsually really), - however, it's difficult for the auto generator to know whether something is a driver/container, which implements a standard API, like Cache/Image Transform/DB etc. or whether the sub files contain important API information - HTML_Quickform_Date for example...
alot of comments contain examples, there is no consistent way of noting/parsing these examples - whether they are HTML (HTML_Template_IT for example), or more common a PHP code use example.
Anyway, considering the challenge, the output is not that bad, it takes about 4 minutes to parse and generate the xml (and phpcodedoc) files here, and about 3 minutes to do a jade of the resulting peardoc manual.
browse the source at
http://docs.akbkhome.com/akpear/
install:
** make sure you have the tokenizer extension....
pear install
http://docs.akbkhome.com/Template_Flexy-0.4.tgz
pear install
http://docs.akbkhome.com/PHP_CodeDoc-0.2.tgz
usage:
modify PHP/CodeDoc/example.ini and point it at the pear CVS tree
run
phpcodedoc example.ini
It really needs some documentation :) - which explains the design concept, (which is pretty simple)...
regards
alan
Até
Antônio
"Can't buy what I want because its FREE!" - Pearl Jam
floripa@PHP.net | PHP & FreeBSD & MySQL | PGP Key ID 0x5BBEB073