You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
If we go for the approach based on @Internal annotation, the repository dokka-tools should be brought to life first. Currently, it's a bit outdated.
Alternatively (and I would NOT go for it right now), there is a way to introduce a custom Javadoc tag, similar to KDoc's @hide. And create a Dokka plugin which would handle it, similar how it handles @hide for Android.
Currently, outer classes generated by Protobuf are included into Javadocs and KDocs. For example, in
io.spine.protodata
package we haveAstProto
,DeclarationsProto
,FileProto
,InsertionProto
, and other classes suffixes withProto
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.The text was updated successfully, but these errors were encountered: