Support for @throws

[alexewerlof]

• I have checked issues with enhancement label and found no duplicates

Problem

jsdocs has a @throws tag that is very useful since any function can @return or @throw. I don't see any reference to this tag in supported tags or the tsdocs declaration reference. Is this a feature that is intentionally avoided? In that case what is the preferred way to document the exceptions that a function throws? If not, is it on the roadmap?

[Gerrit0]

TypeDoc will render any tag you pass by default, even if we don't explicitly support it. #952 (comment)

[alexewerlof]

Yes, I saw that in the rendered page (smart strategy) but I would really like how JSDocs gives them a special place in the output. To me, the @throws is as vital as @returns because they both specify what is the outcome of calling a function.

[Gerrit0]

Fair enough, that should be a fairly simple change to make in the theme, I don't think it would even require any changes to TypeDoc proper.

[aciccarello]

I think we should hold off until microsoft/tsdoc#171 is resolved since it can already be handled as a generic tag. My initial inclination is that it is not necessary.

[aciccarello]

Update: tsdoc is adding @throws as a standard block text tag.

[officialpiyush]

Waiting 👍

[MithileshHinge]

Need this 👍🏽

[sebsonjura]

waiting as well ;) can we haz it?