Re: RE: [PEAR-DEV] Is your package Documented ?

On Apr 14, 2004, at 3:02 PM, Stephan Schmidt wrote:

Hi,

Two questions remain, first how do I automatically add the header and footer when generating the documentation with PHPDocumentor and secondly

This is done automatically by phpDocumentor.

Not really. Remember the automatically generated docs for net_smtp ? We had to spend around 2 hours to fix these and 4 to fill in the missing description. Thanks to didou I made but.. :D Beside, the API alone is hardly sufficient. You need at least an intro and examples.

how often is the peardoc generated? I can't generate my own version of peardoc (no DocBook installed) and I'd like to know when my docs are online.

Docs are generated every Sunday. But you should ask someone to test and commit your docs for you. If you've got errors in the documentation, the build process of the whole manual will fail... That's why there are a lot of "Test before commit" mails are floating around in pear-doc :-)

This is the problem I think. If Dan (which maintains a superlative documentation for pear DB) had some problem to validate changes, looks like an issue :D

Stephan -- PEAR Documentation List Mailing List (http://pear.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php