Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Request for standard documentation #168

Open
xiaoxiangmoe opened this issue Jul 5, 2019 · 4 comments
Open

Request for standard documentation #168

xiaoxiangmoe opened this issue Jul 5, 2019 · 4 comments

Comments

@xiaoxiangmoe
Copy link

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

@Gerrit0
Copy link
Contributor

Gerrit0 commented Jul 5, 2019

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/

@octogonz
Copy link
Collaborator

octogonz commented Jul 5, 2019

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

@qortex
Copy link

qortex commented Jul 8, 2019

@xiaoxiangmoe See #130 for some pointers

@ZLima12
Copy link

ZLima12 commented Oct 14, 2019

Any updates on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants