Re: PEAR::Date docs?
| From: | Greg Beaver | Date: | Wed, 23 Jul 2003 18:23:26 +0000 |
| Subject: | Re: PEAR::Date docs? | ||
| References: | 1 2 3 4 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-6772@lists.php.net to get a copy of this message | ||
Hi Martin,
The official pear documentation is generated from docbook found in the peardoc module of php's cvs. This is what you see at pear.php.net.
The phpdorks.net documentation was generated by phpDocumentor from the source code directly, using the documentation comments found there. This is not an official public pear documentation resource at pear.php.net, but you can always use phpDocumentor to create documentation for projects you need to use as a detailed supplement to the pear.php.net documentation.
The advantage of the pear.php.net documentation is that it is all hand-written by humans, and so often will contain more general concepts that can be hard to find through all the detail generated by an auto-documentation system. The disadvantage is that they are often incomplete or out of date, so I would always check both resources when you have a question, one is likely to have the answer :).
Regards,
Greg
--
phpDocumentor
http://www.phpdoc.org
Martin Marques wrote:
On Mar 22 Jul 2003 13:02, Joshua Eichorn wrote:If anyone is looking i have a copy of the phpDocumentor apidocs here: http://phpdorks.net/docs/api/pear/Date/Date.html If you see any problems with the generated docs you might try submitting a patch with an updated docblock to the maintainer. The docs are for 1.3.1beta, hopefully i'll get all of pear updated again this week but since i parse all instable packages in PEAR at once it takes awhile.Excelent! Now, wasn't it that the PEAR docs were generated with PHPDocumentator??? I'm puzzled.