suppress unwanted docs #1081
Merged
suppress unwanted docs #1081
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bidetofevil
approved these changes
Jul 15, 2024
fractalwrench
force-pushed
the
suppress-unwanted-docs
branch
from
a0bc3f0 to
f5427b4
Compare
|
There isn't a way to get Dokka to understand arbitrary annotations as far as I can see unfortunately. However, given that we're moving most of the internal classes to other modules eventually this should be a much smaller problem in future. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal
Suppresses unwanted symbols that are internal-only from our KDoc.
@hideshould not be used -@supressshould be used instead. Anything inside aninternal.**package is automatically hidden by our Dokka setup.This hides the vast majority of unwanted symbols. We may want to convert some Java classes as part of the major bump to have a mechanism for hiding them (and also get rid of Java code).