Re: Is your package really documented? The truth
| From: | Jon Wood | Date: | Fri, 30 Apr 2004 02:12:43 +0000 |
| Subject: | Re: Is your package really documented? The truth | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-28594@lists.php.net to get a copy of this message | ||
On Thursday 29 April 2004 22:59, David Costa wrote:
> Possible solutions:
>
> a) learn DocBook format and validation, use PHPDocumentor to prepare
> your docs and commit to peardoc
>
> b) Prepare some basic docbook documentation (see
> http://pear.gurugeek.org/ for an explanation and some examples)
> which links to your website or better a Wiki where you have available
> both the API Documentation and some implementation examples.
>
Is there a guide somewhere on how to do this? I just tried to get some docs
done for Auth_PrefManager, and I can't work out what combination of options
needed for phpdoc to generate valid docbook to build as part of the PEAR
manual.
> I am willing to do the PEAR Manual/Docbook linking and basic
> documentation on demand.
>
> Looking forward your suggestions and comments,
>
> Regards
> David Costa