Re: future of PEAR
| From: | Michael Wallner | Date: | Tue, 11 Nov 2003 10:13:49 +0000 |
| Subject: | Re: future of PEAR | ||
| References: | 1 2 3 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-23420@lists.php.net to get a copy of this message | ||
Hi Björn Schotte, you wrote:
> Is there now a 'standard' for documentation? Couldn't see anything
> on the PEAR manual after a quick view. Are there any documentation
> templates that a developer could use?
Yes there is a standard: Docbook XML, or what are you thinking about
with 'standard' in mind? A kind of templates can be found, too:
http://cvs.php.net/cvs.php/peardoc/en/authoring
> Provide an "author's SDK", a .tgz or .ZIP with all kinds of
> templates for classes, documentation, perhaps unit tests and a
> skeleton PEAR package, some kind of automatic tools to verify if a
> PEAR package complies to the standards (or complies to the
> standards for PFC etc.).
I think that's easier to say than to do. How to verify automatically
that a package/class is PEAR compliant than viewing the code
personally - there are as usual many ways to do this right.
When making docs - I think - it's the easiest way to look how others
have done this before.
Questions about Docbook can be most probably best answered here:
http://www.oreilly.com/catalog/docbook/chapter/book/docbook.html
I cannot say much about test cases, because PHPEdit generates them in
a "one click" charm. :-)
Regards,
--
Michael - < mike(@)php.net >
Attachment: [application/pgp-signature]
Attachment: [application/pgp-signature]