Re: standardize @throws for phpdocumentor 2.0?
| From: | Greg Beaver | Date: | Wed, 13 Aug 2003 05:51:23 +0000 |
| Subject: | Re: standardize @throws for phpdocumentor 2.0? | ||
| References: | 1 2 | Groups: | php.general php.general php.pear.doc |
| Request: | Send a blank email to php-general+get-159395@lists.php.net to get a copy of this message | ||
Alex:
What do you think of allowing shortened syntax, since @package is implied. In other words, all packages have to have a @package tag for all classes, so we can safely assume that a package will throw a package_error or a package_warning, etc. then, if we encounter:
@throws error::NOT_FOUND
it can be expanded to:
@throws package_error::PACKAGE_ERROR_NOT_FOUND
Does that sound reasonable?
Greg
Alexander Merz wrote:
Greg Beaver wrote:We are thinking of standardizing the format of @throws for phpDocumentor 2.0. The possible format we'd like to use is:@throws constant|classname [description]@throws error_class::constant description ie @throws PEAR_Error::NOT_FOUND ....