Currently, the generated docs only show generics, parameters and return types. Having the possible exceptions listed could be useful when using a library.
The @throws tag is currently badly supported but this could change if tools made any use of it.
MDN list the possible exceptions under the return types and I think it's a good standard for any documentation. Examples:
Currently, the generated docs only show generics, parameters and return types. Having the possible exceptions listed could be useful when using a library.
The
@throws
tag is currently badly supported but this could change if tools made any use of it.MDN list the possible exceptions under the return types and I think it's a good standard for any documentation. Examples: