[PHP] Re: [PEAR-DOC] standardize @throws for phpdocumentor 2.0?
Greg Beaver wrote: @throws:pear would be a sub-tag of @throws, so that we could have a loose spec for @throws (allowing constant or classname or classname::constant) and a rigid spec for @throws:pear (only classname::constant) +-0 I see the advantage, but the problem here is "the learning by example"-stuff. If i talk about phpdoc, i say to the people "take a look on PEAR to see how the doc comments works". Having a different syntax for PEAR could confuse users. -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Re: [PEAR-DOC] standardize @throws for phpdocumentor 2.0?
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 -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
[PHP] Re: [PEAR-DOC] standardize @throws for phpdocumentor 2.0?
Greg Beaver wrote: 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: I doesn't want to stick to this behavoir, better we allow @throw for the @package doc section. This @throws define a standard namespace/class for the @throws in function scope, ie: * @package myPackage * @throws PEAR_Error */ ... * @throws NOT_FOUND -> PEAR_Error::NOT_FOUND */ function ... * @throws DB_Error::MISSING_DSN */ function ... -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
