Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
The @internal doc flag recognised by tsc should be an alias for @hidden
See original GitHub issueThe @internal flag is used by tsc --stripInternal to exclude a particular property from a generated declaration file. If you’re producing a documented library with public methods for consumption this is basically the same as the @hidden flag you’ll want to use in your typedoc.
It would be great if I could just use @internal and have it work on both my .d.ts and typedoc output.
I realise PRs are needed to make progress on typedoc at the moment but I thought I’d put this up as an issue in case anybody has any better ideas!
Issue Analytics
- State:
- Created 7 years ago
- Reactions:7
- Comments:6 (1 by maintainers)
Top Results From Across the Web
Top Related Medium Post
Top Related StackOverflow Question
Troubleshoot Live Code
Top Related Reddit Thread
Top Related Hackernoon Post
Top Related Tweet
Top Related Dev.to Post
Top Related Hashnode Post
TypeDoc doesn’t produce declaration files, so I don’t think it’s a TypeDoc issue.
The TypeScript compiler options page doesn’t list all options, nor does
tsc --help. If you want to see all options (which does list--stripInternal) you have to runtsc --help --allI wrote a plugin for my project which allows me to mark specific code as
@internalor@external.https://github.com/christopherthielen/typedoc-plugin-internal-external
The plugin also allows you to specify aliases for each annotation.
https://github.com/christopherthielen/typedoc-plugin-internal-external#annotation-aliases