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.
Currently, outer classes generated by Protobuf are included into Javadocs and KDocs. For example, in
io.spine.protodatapackage we haveAstProto,DeclarationsProto,FileProto,InsertionProto, and other classes suffixes withProtofor 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
@Internalannotation for the generated outer classes.Alternatively, we can add a custom annotation similar to
@suppressin KDoc and handle it.