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

JSDoc @api tag #189812

Closed
aweebit opened this issue Aug 7, 2023 · 2 comments
Closed

JSDoc @api tag #189812

aweebit opened this issue Aug 7, 2023 · 2 comments
Assignees

Comments

@aweebit
Copy link

aweebit commented Aug 7, 2023

I have been looking for documentation on the @api tag used to mark private API methods in tj/commander.js, but I could not find any. However, VSCode clearly has support for it because the words private, protected and public following the tag are highlighted differently than other words. I would like to find the code responsible for the highlighting so as to learn about how and why it was added. Could you please point me in the right direction?

@aweebit
Copy link
Author

aweebit commented Aug 7, 2023

I found 9ad4bcd introducing support for the @api tag, but the commit does not seem to be included in any PR, and since there is also no commit description, I could not find any explanation on why the support was added. I would be grateful if you could explain it to me. Is there documentation on the tag somewhere I could not find, or was it simply added to support some de facto usage like the one in the aforementioned Commander library?

@mjbvz
Copy link
Contributor

mjbvz commented Aug 7, 2023

The grammar that provides jsdoc highlighting lives in https://github.com/microsoft/TypeScript-TmLanguage

@mjbvz mjbvz closed this as completed Aug 7, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Sep 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants