- Sponsor
-
Notifications
You must be signed in to change notification settings - Fork 737
Add support for private functions #25
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
Comments
Interesting, I planned to add support for |
Interesting. Are you sure about this? I can't found BTW, join my crusade at typescript repository microsoft/TypeScript#407 about jsdoc documentation support 😉 |
No, I don't follow any guideline when introducing tags, each documentation tool uses it's own set of tags. TypeDoc reflects all tags you put in your doc comments in the output, only a few tags like There are other documentation utilities that support I'll leave a comment at the other issue. I've stumbled upon this problem and TypeDoc implements a similar functionality like you are describing for function overloads. |
Starting with the next version 0.2.3 of TypeDoc you can change the access level of declarations using |
functions and other entities (interfaces, classes, variables). Yes, there is no private classes and functions in typescript. But it could be specified in comments with
@private
tag. It is widespread case for type definition of some javascript code to hint preferred way to use it.In example above
@private
tag was specified and displayed in function description but it has no effect on filtering.The text was updated successfully, but these errors were encountered: