Skip to content

Exclude generated outer classes from including into documentation #153

Open
@alexander-yevsyukov

Description

@alexander-yevsyukov

Currently, outer classes generated by Protobuf are included into Javadocs and KDocs. For example, in io.spine.protodata package we have AstProto, DeclarationsProto, FileProto, InsertionProto, and other classes suffixes with Proto for all Protobuf source code files. There's nothing useful for end users in these documents, they just add up noice by appearing in the list of useful items.

We need to exclude these classes from generated documentation in both Javadoc and KDoc.

One of the possible approaches would be to add @Internal annotation for the generated outer classes.
Alternatively, we can add a custom annotation similar to @suppress in KDoc and handle it.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions