microsoft / tsdoc

A doc comment standard for TypeScript
https://tsdoc.org/
MIT License
4.68k stars 131 forks source link

JSDoc/TSDoc `@inherit[dD]oc` mismatch #359

Open imatlopez opened 1 year ago

imatlopez commented 1 year ago

Seems that TSDoc conflicts with the JSDoc use of @inheritdoc since TSDoc capitalizes the "d" as @inheritDoc.

Is this intentional, if so why? Can both be accepted (given it's too late to go back)?

related VSCode issue: #301

teshanshanuka commented 6 months ago

typedoc does not identify inherit[d]oc. Either way a method description with @inheritDoc is not evaluated by vscode. Would be really nice if it did.

image