Re: Re: PEAR Guide/Docs
| From: | Joshua Eichorn | Date: | Thu, 27 Mar 2003 22:55:37 +0000 |
| Subject: | Re: Re: PEAR Guide/Docs | ||
| References: | 1 2 3 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-4473@lists.php.net to get a copy of this message | ||
If the code has phpDoc style commnts you can generate docs using phpDocumentor (http://phpdoc.org) the output code for docbook still has some issues but standard html output works just fine.
-joshua eichorn
Lead Developer
phpDocumentor
Jon Wood wrote:
But for PEAR ... I really do not know. It is an ongoing project and therefore the source code is the best help. I could imagine that docbook is extracting comments from the sourcecode. That would keep things more simple for the developer as there would be no need to write separate documentation. Quick example ... looking through the helpful PEAR manual: http://pear.php.net/manual/en/ for DB commit, rollback, autocommit functions (which I am using now), I do not find anything there. But I find it in the pear/DB.php and pear/DB/mssql.php source code. A google search for "PEAR DB rollback" will finally lead me to the right site: http://vulcanonet.com/soft/pear_tut/ . This page contains much more information about PEAR DB than ...At the moment the documentation on the PEAR website is a bit (ok, quite a lot) out of date, since the code that will eventually generate the API docs from the source code is under development, so your best bet is, as you said, to look through the comments in the code itself. Jon