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
VachaShah opened this issue
Jan 17, 2024
· 1 comment
· Fixed by #13199
Labels
bugSomething isn't workingBuildBuild Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement.javadocsAnything related to javadocsOtherv2.14.0v3.0.0Issues and PRs related to version 3.0.0
bugSomething isn't workingBuildBuild Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement.javadocsAnything related to javadocsOtherv2.14.0v3.0.0Issues and PRs related to version 3.0.0
Describe the bug
Currently, the classes generated using protobuf are annotated with
Generated
and ignored from the missing javadoc gradle task (Done in #7604). However, theannotate_code
in gradle task does not add theGenerated
annotation to nested classes. This is causing the missing javadoc to fail due to nested classes. For example: https://github.com/opensearch-project/OpenSearch/actions/runs/7561172941/job/20588856740?pr=11910 for proto message: https://github.com/VachaShah/OpenSearch/blob/search-protobuf-part1/server/src/main/proto/server/search/QuerySearchResultProto.proto#L36.Current workaround is to add the classes to
javadocMissingIgnore
.Related component
Other
To Reproduce
./gradlew :server:missingJavadoc
.Expected behavior
No missing javadocs error for proto generated nested code.
Additional Details
Plugins
Please list all plugins currently enabled.
Screenshots
If applicable, add screenshots to help explain your problem.
Host/Environment (please complete the following information):
Additional context
protocolbuffers/protobuf#42 (comment)
The text was updated successfully, but these errors were encountered: