Re: Documentation Suggestion
| From: | Greg Beaver | Date: | Wed, 10 Sep 2003 21:26:26 +0000 |
| Subject: | Re: Documentation Suggestion | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-21381@lists.php.net to get a copy of this message | ||
Wolfram Kriesing wrote:
this kind of tool, which generates php-doc blocks, might be extended a bit and also do the checking if all methods in fact _are_ sufficiently documented. So that it does checks like: - are all parameters documented - are the return values documented - does a short (and a full description) exist and this might throw out the according messages, or even generates the missing tags and does only tell you that you have to fill this in. I think phpDocumentor has already all that functionality, Greg?It doesn't - but could be added easily to the existing version. I guess there will be a need for 1.2.3 before 2.0, huh :(. I hope I can get through all this stuff in the next 6 months! phpDocumentor only throws warnings when it makes assumptions about which package things belong to, or which element a docblock is documenting if there is any possible ambiguity. Greg