[api-extractor] Support @throws tag

[vidartf]

Is this a feature or a bug?

• Feature
• Bug

Tsdoc supports @throws (microsoft/tsdoc#175), but api-extractor still does not support it:

rushstack/apps/api-extractor-model/src/aedoc/AedocDefinitions.ts

Lines 39 to 60 in e5bccec

	configuration.setSupportForTags(
	[
	StandardTags.alpha,
	StandardTags.beta,
	StandardTags.defaultValue,
	StandardTags.deprecated,
	StandardTags.eventProperty,
	StandardTags.example,
	StandardTags.inheritDoc,
	StandardTags.internal,
	StandardTags.link,
	StandardTags.override,
	StandardTags.packageDocumentation,
	StandardTags.param,
	StandardTags.privateRemarks,
	StandardTags.public,
	StandardTags.readonly,
	StandardTags.remarks,
	StandardTags.returns,
	StandardTags.sealed,
	StandardTags.virtual
	],

I have no idea how much work it would be to add this, but it would be useful to have 😃

[octogonz]

It's pretty easy. :-) I think the implementation would be similar to @example.

Would you be interested to implement it?

[vidartf]

Would you be interested to implement it?

Yes, but I would need to some guidance:

• Is the list I added the right place to add it?
• What are other key code locations to look at?

[octogonz]

• Is the list I added the right place to add it?

Yup

• What are other key code locations to look at?

The intended @throws usage is here: microsoft/tsdoc#175

Note that the class name is (optionally) specified as a {@link} on a separate line.

The code that renders @example is here

If you need to visualize the AST, use this tool: https://microsoft.github.io/tsdoc/

Instructions for debugging API Extractor are here: https://api-extractor.com/pages/contributing/building/

For testing your change, use this project: https://github.com/microsoft/rushstack/tree/master/build-tests/api-documenter-test

[vidartf]

So, as far as I am reading you:

• The warning that was previously issued from api-extractor was a hint that the default renderer of api-documenter does not support the @throws tag.
• The main work for a PR would be to add support for the tag in api-documenter's markdown renderer.

Correct?

[octogonz]

Yup!