Re: PEAR Documentation coverage analysis
| From: | Lukas Kahwe Smith | Date: | Wed, 18 Oct 2006 20:43:18 +0000 |
| Subject: | Re: PEAR Documentation coverage analysis | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-44637@lists.php.net to get a copy of this message | ||
Martin Jansen wrote:
On Wed Oct 18, 2006 at 07:3450PM +0200, Christian Weiske wrote:Hmm I was hoping for something slightly different. I was hoping you were scanning the text for mentioning of all the different methods. For MDB2 I have tons of tutorials that explain the bulk of the core API, but this does not seem to get picked up by your script. If it did, it would be a great help to identify the areas that still need to get talked about. regards, Lukasdocumented in the manual and generates some statistics. The extendet version also shows which classes and methods are documented.I don't think we should strive for this sort of doc coverage. The API of all classes is documented pretty well via the auto-generated API documentation. Instead the peardoc documentation should provide examples, tutorials etc. for which it is not necessary to document each and every class and method.