How do I inform users a doccommented magic method can throw an Exception?

Question

I have a doccomment on a class like so:

/**
 * @method Response\FooResponse foo(Parameters\FooParameters $parameters)
 */
class Foo
{
}

This method can throw a FooException. How do I indicate this in the doccomment?

Note for close-voters - this does not already have an answer - the linked answer concerns a first class method not a method annotation. — bcmcfc, Jul 19 '21 at 12:58
The Documentation [On the phpDocs website](https://docs.phpdoc.org/3.0/guide/references/phpdoc/tags/throws.html) — RiggsFolly, Jul 19 '21 at 12:58
@RiggsFolly I don't believe that shows how to use it for a method annotation, only for a 'real' method — bcmcfc, Jul 19 '21 at 12:58
I added `class` under the example to hopefully make the context a little clearer at a glance. — bcmcfc, Jul 19 '21 at 13:00

score 0 · Answer 1 · answered Jul 19 '21 at 12:55

0

Just use PHPDoc's @throws in the docblock to specify which kind of exception might occur in that method.

answered Jul 19 '21 at 12:55

mrodo

This would be a better answer if you showed the OP that coded into his docblock – RiggsFolly Jul 19 '21 at 12:56
I know that exists but I don't know how to bring it into a `@method` annotation specifically. I couldn't find that documented anywhere. – bcmcfc Jul 19 '21 at 12:57

score 0 · Answer 2 · answered Jul 19 '21 at 12:57

0

Since JSDocs are similar in definitions, you can use @throws. Check this article for reference: https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#throwstag

answered Jul 19 '21 at 12:57

CyberDev

2 Answers2