Re: future of PEAR
| From: | Stefan Neufeind | Date: | Tue, 11 Nov 2003 10:48:03 +0000 |
| Subject: | Re: future of PEAR | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-23422@lists.php.net to get a copy of this message | ||
On Tue, 11 Nov 2003 at 09:12:30, luca\.mariano\@email\.it wrote:
> > Dunno. But here are completely undocumented *categories*, you can count
> the
> > number of "stable" packages in them for a start:
> >
> > http://pear.php.net/manual/en/package.benchmarking.php
> > http://pear.php.net/manual/en/package.caching.php
> > http://pear.php.net/manual/en/package.datetime.php
> > http://pear.php.net/manual/en/package.images.php
> > http://pear.php.net/manual/en/package.math.php
> > http://pear.php.net/manual/en/package.numbers.php
> > http://pear.php.net/manual/en/package.payment.php
> > http://pear.php.net/manual/en/package.science.php
> >
>
> I think that some criteria should be used to found which packages really need
> for documentation ASAP.
> In fact there're very simple package with good inline examples (such
> benchmarking), a medium skills PHP developer should not have problem with
> this stuff...
> Of course all PEAR classes must be documented, but without a priority it's a
> hardest work for the community...
While we're at it: Afaik some while ago someone raised a short discussion on
how to actually write docs. Greg said there are howtos for phpDocumentor - but
haven taken a short look at them myself a while ago I must say that I was only
able to get a simple doc from the inline commands with phpDocumentor.
Maybe could someone who is familiar with writing docs please post a link to a
small howto (2 pages at most)? This howto should then include all the steps
from generating the docs from inline comments, improving them by writing
extensive additional documentation around that and submitting it to the doc-
system used at pear.php.net. Would really much appreciate that!
Regards,
Stefan