Re: Doc help requestedd (was: RE: Is your package Documented ?)

From: Date: Wed, 14 Apr 2004 13:46:17 +0000
Subject: Re: Doc help requestedd (was: RE: Is your package Documented ?)
References: 1 2  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-3418@lists.php.net to get a copy of this message
Cynical off-topic two-line response from "Jones the Ogre" is at the very, very end. On Apr 14, 2004, at 8:41 AM, David Costa wrote:
On Apr 14, 2004, at 8:32 AM, Christian Wenz wrote:
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.
you should validate changes locally as per http://www.php.net/manual/howto/ on "validating changes" to do that you need openjade and libxml installed
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 ;)
well on webservices.xml I see only <chapter id="package.Web Services"> <title>Web Services</title> &package.Web Services.uddi; </chapter> this won't work I think
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.
heh well I think what you have is the API documentation but you might need examples, intro and much more. That said, as it is an alpha package what you have should be sufficient.
[...]
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. :-)
Not really that automatic. You still need to check it and run a number of tests...
... and we wonder why we don't have more people willing to do documentation? Good grief, if it's this much trouble, then there *is* a problem with the system. -- Paul M. Jones Savant: the simple alternative to Smarty. http://phpsavant.com/

« previous php.pear.doc (#3418) next »