Skip to content

Option to skip declarations marked with an annotation #1861

@rnett

Description

@rnett

Is your feature request related to a problem? Please describe
I have a few @RequiresOptIn annotations that I'm using in my project. One of them is for internal APIs that I need to have public for other modules. I would like to not generate documentation for anything with this annotation.

Describe the solution you'd like
A way to skip declarations that have certain annotations.

Describe alternatives you've considered
Skip declarations for any @RequiresOptIn annotation: this is bad because @RequiresOptIn can be used for experimental annotations as well as internal, or things like a plugin API that will be used in some cases but not all.

A selector in the HTML docs (and potentially others) to filter by @RequiresOptIn annotations that are registered in the configuration (w/ configurable defaults): I would like to see this as well (#1862), but it's not exclusive with skipping some altogether.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementAn issue for a feature or an overall improvementplugin idea

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions