Re: Doc help requestedd (was: RE: Is your package Documented ?)
| From: | Christian Wenz | Date: | Wed, 14 Apr 2004 14:14:21 +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-3424@lists.php.net to get a copy of this message | ||
Hi David,
> 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
that's what I wanted to avoid. I do most of my Web Services
testing/development on a Windows machine, since I want to test .NET
interoperability... :-(
> 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
ok, fine -- but how should I avoid that? Manually edit webservices.xml so
that all packages within the Web Services section are there and PEAR::UDDI is
added?
> 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.
well, there will be examples, intro aso., however I first would like to have
a semi-automatic workflow that generates the documentation for me. However
obviously this is not the case yet (for me).
> >> 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...
>
well, obviously these tests would fail right now ;) are the other XML files
generated okay -- so do I only need to patch the webservices.xml file? These
are the points I am quite interested in. IIRC, Stephan mentioned earlier that
he has an automatic process for the XML creation, so I am confident there is
a way. However I also do agree with Alexander when he writes (in another
thread): "[...]but the main step from XML:DocBook/peardoc2:default to CVS is
missing".
Regards
Christian