tsdoc icon indicating copy to clipboard operation
tsdoc copied to clipboard

Request for standard documentation

Open xiaoxiangmoe opened this issue 6 years ago • 4 comments

Does tsdoc have standard documentation? How should we search which tags are there and what the actual meaning of each tag is?

xiaoxiangmoe avatar Jul 05 '19 17:07 xiaoxiangmoe

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/

Gerrit0 avatar Jul 05 '19 17:07 Gerrit0

I will work on putting up some proper documentation this month. We have procrastinated it too long. :-)

octogonz avatar Jul 05 '19 19:07 octogonz

@xiaoxiangmoe See https://github.com/microsoft/tsdoc/issues/130 for some pointers

qortex avatar Jul 08 '19 10:07 qortex

Any updates on this?

ZLima12 avatar Oct 14 '19 14:10 ZLima12