react-docgen icon indicating copy to clipboard operation
react-docgen copied to clipboard

Document TSDoc support

Open jsamr opened this issue 5 years ago • 0 comments

Related to #458, but TSDoc (a tool maintained by Miscrosoft) although influenced by JSDoc, has a strictly distinct syntax. For example, @default in JSDOC is @defaultValue in TSDOC. @inheritDoc doesn't have the same semantics, and require an argument in TSDoc... etc.

The full specification is yet to be written, but there is already a very well documented syntax reference here. See https://github.com/microsoft/tsdoc/issues/130 for updates on this specific issue.

jsamr avatar Sep 13 '20 12:09 jsamr