Re: Writing PEAR documentation
| From: | (Alexander Merz) | Date: | Thu, 06 Jun 2002 13:28:02 +0000 |
| Subject: | Re: Writing PEAR documentation | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-6743@lists.php.net to get a copy of this message | ||
Bertrand Mansion wrote:
1. Is it possible to split the documentation in 2 or 3 pages ? How ? QuickForm is a big class and it will be hard to make all fit in just a single HTML. Don't care about this, you have to write the docs in Docbook not in HTML. How this will rendered depends on the user, not the author.As starting point you should download the peardoc2.zip from http://www-user.tu-chemnitz.de/~meal/php/peardoc2/peardoc2.zip. It contains a 'template' directory which includes templates for docs and some information about how the doc is organized. Your Docs should go in "en/package/html/html-quickform/" (note there is already a dummy entry)
2. Is there a way to get the comments we took time to write in the source code and make them compliant with the PEAR documentation in xml ? I've heard of PHPDoc. Is it the right tool for that ? If so, do you have any clues on how to make it work fine from the first time ? Or do I have to do all this manually. Unfortunatly manually at the moment. I will start work on a docbook renderer for phpdoc, if i finished converting the old manual stuff to peardoc2.