Skip to content

Consider using @suppress KDoc tag for internal API elements #35

@alexander-yevsyukov

Description

@alexander-yevsyukov

KDoc has the @suppress tag which allows to hide documentation for corresponding API element.

Two areas we can consider for not showing our internal API:

  1. Annotator in McJava could also annotate generated Kotlin DSL.
  2. We can add the @suppress tag in the handwritten code where we use @Internal annotation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions