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

[Docs] Use --stripInternal in TypeDoc #12923

Closed
2 tasks done
deyaaeldeen opened this issue Dec 16, 2020 · 0 comments
Closed
2 tasks done

[Docs] Use --stripInternal in TypeDoc #12923

deyaaeldeen opened this issue Dec 16, 2020 · 0 comments
Assignees
Labels
Central-EngSys This issue is owned by the Engineering System team. Client This issue points to a problem in the data-plane of the library. Docs EngSys This issue is impacting the engineering system.

Comments

@deyaaeldeen
Copy link
Member

deyaaeldeen commented Dec 16, 2020

#12912 removes the use of the @ignore JSDoc tag from our code base and replaces it with @internal. For the latter to work, we need to pass --stripInternal to TypeDoc.

IIRC, there are two documentation systems being used where this flag should be used

--stripInternal is introduced in TypeDoc v0.15.2.

@deyaaeldeen deyaaeldeen added Docs EngSys This issue is impacting the engineering system. labels Dec 16, 2020
@ramya-rao-a ramya-rao-a added the Client This issue points to a problem in the data-plane of the library. label Dec 17, 2020
@scbedd scbedd added the Central-EngSys This issue is owned by the Engineering System team. label Jan 12, 2021
@scbedd scbedd closed this as completed Jan 14, 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
Central-EngSys This issue is owned by the Engineering System team. Client This issue points to a problem in the data-plane of the library. Docs EngSys This issue is impacting the engineering system.
Projects
None yet
Development

No branches or pull requests

3 participants