PHPDocumentor manual and @throws tag
| From: | Laurent Laville | Date: | Tue, 20 Nov 2007 09:11:25 +0000 |
| Subject: | PHPDocumentor manual and @throws tag | ||
| Groups: | php.pear.dev | ||
| Request: | Send a blank email to pear-dev+get-48492@lists.php.net to get a copy of this message | ||
Hello,
While I tried to fix coding standard error (recommanded by PHP_CodeSniffer), such as :
496 | ERROR | @throws tag must contain a comment
I look at official manual [1] and don't see any entry. Well I suppose it's missing. Could we have some information about this phpdoc tag, and how to document it.
Actually, I set in code, for example :
* @throws PEAR_PACKAGEFILEMANAGER_NOSTATE
* @throws PEAR_PACKAGEFILEMANAGER_NOVERSION
* @throws PEAR_PACKAGEFILEMANAGER_NOPKGDIR
* @throws PEAR_PACKAGEFILEMANAGER_NOBASEDIR
* @throws PEAR_PACKAGEFILEMANAGER_GENERATOR_NOTFOUND_ANYWHERE
* @throws PEAR_PACKAGEFILEMANAGER_GENERATOR_NOTFOUND
* @access public
* @since 0.1
So I suppose comment is missing right after constants PEAR_PACKAGEFILEMANAGER_*
Thanks in advance to give us more explain, please
Laurent
[1] http://manual.phpdoc.org/HTMLframesConverter/phpdoc.de/