Re: PHPDocumentor manual and @throws tag
| From: | Carsten Wiedmann | Date: | Tue, 20 Nov 2007 12:53:37 +0000 |
| Subject: | Re: PHPDocumentor manual and @throws tag | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-48495@lists.php.net to get a copy of this message | ||
Chuck Burgess schrieb:
So I suppose comment is missing right after constants PEAR_PACKAGEFILEMANAGER_* That Codesniffer error does indeed sound like it is specifically targeting the *@throws* tag as if it is a specific tag requirement, and wants a comment/description piece after the exception type (*@throws ExceptionType some description now*). So, I'm guessing it wants something like this:If I read the sample file [1], line 203
| * @throws exceptionclass [description]correct, the description is optinional ("[]"). Thus if Codesniffer knows the "@throws" tag, this is a bug in Codesniffer (requires a description)? Another question: If there is a description, what is the folding rule. The same as for @return? Regards, Carsten [1] http://pear.php.net/manual/en/standards.sample.php