tsdoc
tsdoc copied to clipboard
Request for standard documentation
Does tsdoc have standard documentation? How should we search which tags are there and what the actual meaning of each tag is?
I believe the best documentation for this right now is in the source of this library: https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/details/StandardTags.ts
You can also look at the documentation for API Extractor, but there are some tags there which are specific to that application. https://api-extractor.com/pages/tsdoc/doc_comment_syntax/
I will work on putting up some proper documentation this month. We have procrastinated it too long. :-)
@xiaoxiangmoe See https://github.com/microsoft/tsdoc/issues/130 for some pointers
Any updates on this?