docs: generate documentation for non-public symbols #631
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.
PR Submission Checklist for internal contributors
The PR Title
The PR Description
What's new in this PR?
Issues
Dokka is only generating documentation for public stuff.
A lot of the documentation we do is useful for us developing it too. Especially the
internal
symbols.So important classes and definitions, like
EventGatherer
do not have generated documentation.Solutions
Ideally, we could specify the visibility-level of the things we want to genereate documentation from/to.
But for this, we would need Dokka 1.6.20 (see Kotlin/dokka#434 (comment)) and we're not there yet.
In the meanwhile, we can use
includeNonPublic
and generate for everything.Testing
N/A
PR Post Merge Checklist for internal contributors
References
feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764
.