Doc help requestedd (was: RE: Is your package Documented ?)
| From: | Christian Wenz | Date: | Wed, 14 Apr 2004 06:32:07 +0000 |
| Subject: | Doc help requestedd (was: RE: Is your package Documented ?) | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-3403@lists.php.net to get a copy of this message | ||
Hi pear-doc,
following the discussions on pear-dev and pear-doc of the last few days,
and David's "open call", I'd ask if someone could give me some pointers
about documentation. For PEAR::UDDI, we have always used phpDocumentor
to create PDF, HTML and CHM API documentation, however we didn't dare
yet to commit DocBook directly into CVS. But maybe this will change.
First (and probably biggest) question is: What steps are necessary to
update the XML created by phpDocumentor to make it valid for CVS. If
anyone would like to have a look:
http://web-services.cc/XMLDocBookpeardoc2Converter/
I have no clue how many obvious mistakes I've made when running
phpDocumentor, but some of you will hopefully spot those ;)
Finally, answering David's question(s):
> You have documentation on your personal site in a different format ?
> let us know!
there is documentation in HTML, PDF and CHM; the link is on the
PEAP::UDDI project page.
[...]
> Documentation can be automatically-generated using PHPDocumentor
> http://pear.php.net/package/PhpDocumentor/
that's what I'd like to find out -- but I only believe it when I see it.
:-)
Regards,
Christian