Skip to content

Exclude Internal API from documentation #929

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

Closed
yordis opened this issue Dec 27, 2018 · 1 comment
Closed

Exclude Internal API from documentation #929

yordis opened this issue Dec 27, 2018 · 1 comment

Comments

@yordis
Copy link

yordis commented Dec 27, 2018

As a user, I should be able to exclude internal code from the generated documentation.

Internal code is the code that it is not exported in the files. If the user didn't export specific code snippet, like variables, or functions, probably means that it is not part of the public API so I would like to exclude those from the documentation.

Currently, I have to be putting @hidden everywhere in my source code, which makes the source code a little bit ugly.

Maybe introduce a flag that will allow me to do this.

@yordis yordis changed the title Internal vs Public API for documentation Exclude Internal API for documentation Dec 27, 2018
@yordis yordis changed the title Exclude Internal API for documentation Exclude Internal API from documentation Dec 27, 2018
@aciccarello
Copy link
Collaborator

Thanks for the input. This would be covered by #639 so I'll close this as a duplicate.

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

No branches or pull requests

2 participants