Writing PEAR documentation

From: Date: Thu, 06 Jun 2002 11:49:30 +0000
Subject: Writing PEAR documentation
References: 1  Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-6741@lists.php.net to get a copy of this message
Hi all, I've started to write documentation for HTML_QuickForm. I have some questions about the documentation in PEAR. 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. 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. And another question, not related to documentation: Are there going to be subcategories in categories to put packages in. For instance, I've seen that in the category table there were parent, right and left fields. Are we going to use them ? That's it for now, TIA. Bertrand Mansion Mamasam

« previous php.pear.dev (#6741) next »