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

feat: Implement @internal as synonym of @hidden #525

Closed
wants to merge 1 commit into from

Conversation

BurtHarris
Copy link

Fixes #364 The @internal doc flag recognised by tsc should be an alias for @hidden
Fixes #198 Support for @ignore?

@aciccarello
Copy link
Collaborator

Thanks for the PR! I do think we need to think through if @internal should always be hidden. I know that @internal has it's own meaning outside of TypeDoc. Is there anything in the semantics of that tag that would conflict with documentation?

@BurtHarris
Copy link
Author

BurtHarris commented Jun 8, 2017

@aciccarello Having thought about it some myself, this could get as complicated as you want to make it, especially since TypeScript's support for @internal is still experimental. I don't think there's any shame in treating its support in typedoc as experimental.

For my project the documentation spew from typedoc is already enormous (primarily because it was ported from an existing Java class library with extensive doc comments. and I'm looking for any way I can to narrow what's generated to a limited "public" API in the semver sense.

Typedoc already seems to go digging much deeper than is justified by the façade module I pass it. I often end up with documentation related to test case classes and benchmarks, which make no sense to include in the public API.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Nov 14, 2019

Closing as this was implemented in #1114, which has now been merged + published. Somehow I missed this PR when making that..

@Gerrit0 Gerrit0 closed this Nov 14, 2019
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

Successfully merging this pull request may close these issues.

The @internal doc flag recognised by tsc should be an alias for @hidden Support for @ignore?
3 participants