Support for `@throws`

[jan-molak]

Hey @milesj! It would be great if docusaurus-plugin-typedoc-api supported rendering information about the errors a method @throws

/**
 * @throws {@link UserError} if `max < min`
 */
export function rand(min: number, max: number): number;

At the moment, both @throws {CustomError} and @throws {@link CustomError} seem to be ignored.

[milesj]

@jan-molak Not a bad idea.

Does it not render at all below the comments though?

[jan-molak]

Not at the moment, here's my TSDoc:

   /**
     * Gives this Actor a list of {@link Ability|abilities} they can use
     * to interact with the system under test or the test environment.
     *
     * @param abilities
     *  A vararg list of abilities to give the actor
     *
     * @returns
     *  The actor with newly gained abilities
     *
     * @throws {@link ConfigurationError}
     *  Throws a ConfigurationError if the actor already has an ability of this type.
     */
    whoCan(...abilities: Ability[]): Actor {

and here's the rendering:

[milesj]

@jan-molak Awesome, thanks, will look into.

[milesj]

These should render now.

[jan-molak]

And they do, thank you!