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

Kotlin / dataframe

Structured data processing in Kotlin

https://kotlin.github.io/dataframe/overview.html

Apache License 2.0

772 stars 48 forks source link

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

Open Jolanrensen opened 4 months ago

Jolanrensen commented 4 months ago

Ever since the doc processors was updated to 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.

Jolanrensen commented 3 months ago

Let's introduce this gradually when we make new doc interfaces or we spot a good place for it