[Core] Fix usage of @internal and @hidden tags
See original GitHub issuePlease follow the following guidelines:
- use the
@internal
tag only for definitions that are not exported bysrc/index.ts
and you do not want to generate documentation for them ondocs.microsoft.com
- use the
@hidden
tag only for definitions that are exported bysrc\index.ts
but you still do not want to generate documentation for them ondocs.microsoft.com
- do not use both
@internal
and@hidden
for one definition
Issue Analytics
- State:
- Created 3 years ago
- Reactions:1
- Comments:7 (7 by maintainers)
Top Results From Across the Web
Cache tags | Cache API | Drupal Wiki guide on Drupal.org
Comprehensive use of cache tags across Drupal allows Drupal to ship with its Internal Page Cache enabled by default. This is nothing more...
Read more >Tag Pages & Content Tagging For SEO: A Complete Guide
Tagging can benefit SEO, personalization, and UX when done correctly. Avoid the pitfalls with this complete guide to tagging SEO.
Read more >Practical uses for the "internal" keyword in C# - ...
A common use of internal access is in component-based development because it enables a group of components to cooperate in a private manner...
Read more >How to hide property from displaying in Swagger? #1230
I am using .NET Core 2.2. [DataContract] ends up showing all members anyway; marking attribute as 'internal' or [JsonIgnore] doesn't deserialize ...
Read more >Git - git-tag Documentation
The latter are usually not interested in the detailed tags used internally in the former group (that is what "internal" means). That is...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I’m leaning toward “leave those things hidden unless we have a good reason” since they’re all stuff that we’d not want external devs to see/think about
Thanks all!