Re: Is your package Documented ?

On Tuesday 13 April 2004 02:27 pm, David Costa wrote: > On Apr 13, 2004, at 10:03 PM, Ian Eure wrote: > > On Tuesday 13 April 2004 11:48 am, David Costa wrote: > >> Documentation can be automatically-generated using PHPDocumentor > >> http://pear.php.net/package/PhpDocumentor/ > > > > The documentation I've seen PHPDocumentor produce differs > > substantially from > > the user-friendly docs in the PEAR manual. The PHPDoc page also makes > > this > > claim, but doesn't explain how to generate such documentation. > > Ian, it depends on your comments but I agree, is not really totally > automatic, you still need to do some work ;) > Ok. The PHPDoc site gave the impression that you could automaticly generate end-user docs from the docblocks. > ah..I see you have some docs for > http://pear.php.net/package/Payment_Process but on your site so > you are > good candidate for the > bridge solution but you need to add examples, and some more details > documentation on how to use it. Add it to your site if you like but > with > the current status of the docs a potential user might just be at a > loss.. > > Let me know when you are done with the examples so I can have a look > and add it to the manual. > Sure. It's still under development at the moment, so the docs are more focused on people who are going to be developing for it, but I definitely want a nice manual for the 1.0 release.