Re: Real documentation?
| From: | Mika Tuupola | Date: | Thu, 01 Jan 1970 00:00:00 +0000 |
| Subject: | Re: Real documentation? | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-1406@lists.php.net to get a copy of this message | ||
On Sun, 12 Aug 2001, Richard Heyes wrote:
>
> Does anyone have any interest in including real documentation in PEAR? ie.
> Hand typed examples and instructions on usage? These could go in the class
> files themselves, or maybe a similar named file as the class, eg
> Mail/sendmail.txt, Mail/RFC822.txt, Mail/smtp.txt etc.
I think there should be something like doc/ directory under
every package which includes simple txt files having the examples
you mentioned. PHPDoc should still be there but I think developer
should be able to check usage etc without first running PHPDoc
against the class files.
--
Mika Tuupola http://www.appelsiini.net/~tuupola/