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.

Sign up for GitHub

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

Jump to bottom

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

Open
Jolanrensen opened this issue Feb 27, 2024 · 1 comment
Open

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

Jolanrensen opened this issue Feb 27, 2024 · 1 comment
Assignees
@Jolanrensen
Labels
KDocs Improvements or additions to KDocs
Milestone
KDocs for the pub...

Comments

@Jolanrensen
Copy link
Collaborator

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 Jolanrensen added the KDocs Improvements or additions to KDocs label Feb 27, 2024
@Jolanrensen Jolanrensen added this to the KDocs for the public API milestone Feb 27, 2024
@Jolanrensen Jolanrensen self-assigned this Feb 27, 2024
@Jolanrensen Jolanrensen mentioned this issue Mar 7, 2024
Merged
@Jolanrensen
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Jolanrensen Jolanrensen

Labels
KDocs Improvements or additions to KDocs
Projects
None yet
Milestone
KDocs for the public API
Development

No branches or pull requests
1 participant
@Jolanrensen