Re: Is your package Documented ?

Paul M Jones wrote:

Documentation can be automatically-generated using PHPDocumentor http://pear.php.net/package/PhpDocumentor/

Jones the Ogre speaks: PhpDocumentor itself is not in the PEAR documentation. Is that bad? :-(

This isn't technically true. The PHPDoc documentation on what tags are valid still applies. It took a solid month of 4 hour days to write the phpDocumentor manual in phpDocumentor format. Easily converting it to peardoc format is impossible for several reasons: 1) the docbook in the tutorials is (gasp) not 100% valid docbook, as I actually used them to learn how docbook works, and the online O'Reilly stuff isn't as accurate or clear on what can be nested in what as it should be (HUGE problem with docbook in my book) 2) almost everything is organized into a subpackage of some sort. peardoc's implementation of docbook doesn't have any support for this. 3) all the nice source highlighting with linking just isn't at all possible in docbook (this one is minor, I guess) If you want to talk about requirements, the ability to change the manual format in the future is a pretty strong requirement. If you wish to re-organize the current DocBook manual at all when a better way of doing things is discovered, you have to find someone who understands dsssl, knows how all the various configure and make scripts work, and knows which php scripts are used to do what. In other words, you have to find the equivalent of the easter bunny or a scrupulous politician - they do appear once and a while, but was that a figment of your imagination? Greg