Re: [PEPr] +1 for Networking::Net_Gearman

On Fri, Apr 25, 2008 at 11:12 AM, Joe Stump <joe@joestump.net> wrote: > > - @throws documentation should say why an exception would be thrown >> > > Added this. This, btw, is not documented on phpdoc.org. Someone needs to > poke Josh Eichorn. :) > > @throws is not a native PhpDocumentor tag... it is a "custom" tag that just happens to already be listed in the [_phpDocumentor_tags_allowed] section of phpDocumentor.ini. So, it's allowed (i.e. won't register a warning/error), but it's just a generic tag (i.e. @throws put anything here you want to, 'cause it's not parsed as anything but free text). To get the best mileage out of it, I suggest: * @throws {@link Your_Exception_Classname} description of what can cause this exception to be triggered That inline link tag means the @throws info in your doc will have the link to the exception class. Otherwise, just putting the exception classname there will not make it a link. -- CRB