Kotlin / Kotlin/dataframe

Annotate non-user facing documentation interfaces with `@ExcludeFromSources`

Open
#605 2 comments 0 reactions 1 assignee Claimed by @Jolanrensen View on GitHub
infrastructure KDocs
Dominant language
Kotlin
Stars
1.1k
Forks
83
Avg merge
4d 12h
Merged PRs (30d)
30

Description

Ever since the doc processors was updated to [v0.3.2](https://github.com/Jolanrensen/docProcessorGradlePlugin/releases/tag/v0.3.2), we've had the `@ExcludeFromSources` annotation at our disposal.
This allows temporary doc-interfaces to be excluded from our preprocessed source files, cleaning them up a lot. It might also shrink our bytecode size, since there are fewer interfaces to be compiled.
Finally, it could help in other future applications. For instance, the `dokkaJekyll` task failed before I added `@ExcludeFromSources` to `api/all.kt`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.