Re: Re: Is your package Documented ?
| From: | David Costa | Date: | Sun, 18 Apr 2004 19:11:20 +0000 |
| Subject: | Re: Re: Is your package Documented ? | ||
| References: | 1 2 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-3629@lists.php.net to get a copy of this message | ||
On Apr 18, 2004, at 5:27 PM, Sérgio Carvalho wrote:
My only package so far, Structures_Graph is documented, but: a) isn't in the PEAR manualDone, I added your package to the manual with the relevant link, see CVS commit
b) does not have a "Documentation" link in its PEAR page: http://pear.php.net/package-info.php?package=Structures_Graphnow, for the B (linkage to the package docs) I think this is the right way http://pear.php.net/manual/en/developers.packagedef.php "doc Documentation file {PEAR_documentation_dir}/Package_Name/" but I am not 100% sure perhaps someone with more experience on this might help ;) Cheers David Costa
How do I achieve both? Cheers, Sérgio Carvalho David Costa wrote:Is you package documented and listed in the pear manual ? If the answer to this question is No, please let us know why not ;) (email the Doc list at pear-doc@lists.php.net) You have documentation on your personal site in a different format ? let us know! Extensive documentation (whenever possible with clear, "for dummies" examples) is critical to ensure both your package and PEAR success among users. Documentation can be automatically-generated using PHPDocumentor http://pear.php.net/package/PhpDocumentor/ Thanks in advance for your time and attention, Regards, David Costa http://dotgeek.org gurugeek att php dot net david at postgresql ddoot org