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

Add many PrivateApi attributes to hide unimportant stuff in docs #1793

Merged
merged 1 commit into from
Nov 17, 2021

Conversation

iJungleboy
Copy link
Contributor

The docs should help people use the Oqtane API as best as possible. As such, we should hide objects which are just for internal work or won't be used as an API. I've added [PrivateApi] attributes to ca. 20 classes which clutter up the docs without real benefit to the user.

As an example, I've removed tagged all the HtmlText classes, since that's not an API I expect others to need in the docs - this removes these entries from the docs:

image

  • a few others, all which I'm convinced serve no benefit in the docs.

Otherwise no code changes.

@sbwalker sbwalker merged commit 16d9e06 into oqtane:dev Nov 17, 2021
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

Successfully merging this pull request may close these issues.

2 participants