Skip to content

@ExposedType annotation should be @Documented #388

@Stewori

Description

@Stewori

@ExposedType should be @Documented, because it's relevant for users to know and shouldn't require reading the source code. Same for @ExposedMethod etc. I self fell for this in #387 (comment) where I suggested the wrong method even after looking into API docs. I might have noticed it easier if @ExposedType and @ExposedMethod were not hidden by default, which is a consequence of being considered not @Documented. (In the APIdia docs one can force-show annotations which are not @Documented via a filter in the top-right menu. Conventional Javadoc excludes them completely.)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions