Skip to content

Add alias for specific comment tag #313

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

Closed
iveetoo opened this issue Oct 18, 2016 · 1 comment
Closed

Add alias for specific comment tag #313

iveetoo opened this issue Oct 18, 2016 · 1 comment

Comments

@iveetoo
Copy link

iveetoo commented Oct 18, 2016

Is there a way to register alias for specific comment tag?

I use the TypeScript compiler option stripInternal: true with the @internal tag to not emit declarations for some utility functions that are used internally. Also, I do not want to generate documentation for these utilities. I found the @hidden tag (#62) , that excludes the symbol from the generated documentation. Now, my .ts files has two comment tags:

/**
 * @internal
 * @hidden
 */
export function someUtility () { ... }

I would like to be able to register internal as alias for hidden tag. Thanks.
Before I've found the @hidden tag, I was forced to generate the doc from the .d.ts file to exclude the utilities, but there is other issue (#186)

@aciccarello
Copy link
Collaborator

Closing in favor of #364 since it is more specific. I think handling this case specifically makes more sense than allowing user defined aliases.

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

2 participants