Skip to content

Add alias for specific comment tag #313

Closed
@iveetoo

Description

@iveetoo

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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions