Re: Is your package Documented ?
| From: | David Costa | Date: | Tue, 13 Apr 2004 21:27:34 +0000 |
| Subject: | Re: Is your package Documented ? | ||
| References: | 1 2 | Groups: | php.pear.dev php.pear.doc |
| Request: | Send a blank email to pear-dev+get-27595@lists.php.net to get a copy of this message | ||
On Apr 13, 2004, at 10:03 PM, Ian Eure wrote:
On Tuesday 13 April 2004 11:48 am, David Costa wrote:Ian, it depends on your comments but I agree, is not really totally automatic, you still need to do some work ;) 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. Cheers David CostaDocumentation 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.
Perhaps a guide on this subject would get more package documentation in the PEAR manual. -- PEAR Development Mailing List (http://pear.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php