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

[Event Hubs] Fix usage of @internal and @hidden tags #13455

Closed
deyaaeldeen opened this issue Jan 28, 2021 · 0 comments · Fixed by #19477
Closed

[Event Hubs] Fix usage of @internal and @hidden tags #13455

deyaaeldeen opened this issue Jan 28, 2021 · 0 comments · Fixed by #19477
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Docs Event Hubs

Comments

@deyaaeldeen
Copy link
Member

Please follow the following guidelines:

  • use the @internal tag only for definitions that are not exported by src/index.ts and you do not want to generate documentation for them on docs.microsoft.com
  • use the @hidden tag only for definitions that are exported by src\index.ts but you still do not want to generate documentation for them on docs.microsoft.com
  • do not use both @internal and @hidden for one definition
@deyaaeldeen deyaaeldeen added this to the Backlog milestone Jan 28, 2021
@ramya-rao-a ramya-rao-a modified the milestones: Backlog, [2021] December Jul 21, 2021
@ramya-rao-a ramya-rao-a added the Client This issue points to a problem in the data-plane of the library. label Jul 21, 2021
@ramya-rao-a ramya-rao-a self-assigned this Dec 20, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Client This issue points to a problem in the data-plane of the library. Docs Event Hubs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants