Skip to content

Suggestion: exclude @internal #867

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
rbuckton opened this issue Oct 3, 2018 · 1 comment
Closed

Suggestion: exclude @internal #867

rbuckton opened this issue Oct 3, 2018 · 1 comment

Comments

@rbuckton
Copy link

rbuckton commented Oct 3, 2018

TypeScript supports --stripInternal as an advanced compiler flag, in which declarations that have an @internal tag in their comments are stripped from output declaration files. Ideally, TypeDoc should exclude declarations from documentation marked with /** @internal */, similar to the logic here: https://github.com/rbuckton/iterable-query/blob/refactor/src/typedoc-plugin-custom/plugin.ts#L381.

This may need to be configurable, as the typedoc-plugin-internal-external package also uses @internal by default.

@aciccarello
Copy link
Collaborator

Thanks for your feedback @rbuckton. There already is some discussion of this in #364

You bring up a good point about the effect ignoring it would have on plugin users. Maybe @christopherthielen could provide some feedback. His while plugin allows using another tag name I imagine many use the default of @internal.

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