Re: Including API Doc
| From: | Greg Beaver | Date: | Wed, 13 Aug 2003 18:58:22 +0000 |
| Subject: | Re: Including API Doc | ||
| References: | 1 2 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-1315@lists.php.net to get a copy of this message | ||
Philip,
version 1.2.1's peardoc converter was buggy, because at the time I had no way of testing the output from it. 5 months of appeals to developers to let me know about bugs yielded very few responses. Now I have linux and 1.2.2, which is due to be released this week, has fully working peardoc output.
When you say you could never get it working, did you mean at all, or just the peardoc output?
Greg
Philip Olson wrote:
It would be nice if someone with phpdocumentor skills would add missing docs to peardoc so the doc teams could work with them. I personally can never get phpdocumentor to work... I feel the idea is to have phpdocumentor create the initial docs based off the commented code, and allow humans to keep it updated. Is this correct? Many packages (especially older ones) are missing from peardoc, but have well commented API code. Regards, Philip On Tue, 12 Aug 2003, Stephan Schmidt wrote:Hi, I've got a question on generated API documentation. Should I include documentation generated by phpDocumentor in the downloadable package, or is it sufficient to add it to peardoc? I think having an offline documentation is nice, but when there's documentation available online, it just increases the package size... Stephan -- PEAR Documentation List Mailing List (http://pear.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php