Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] Fix missing javadocs error for nested classes generated using protobuf #11913

Closed
VachaShah opened this issue Jan 17, 2024 · 1 comment · Fixed by #13199
Closed

[BUG] Fix missing javadocs error for nested classes generated using protobuf #11913

VachaShah opened this issue Jan 17, 2024 · 1 comment · Fixed by #13199
Labels
bug Something isn't working Build Build Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement. javadocs Anything related to javadocs Other v2.14.0 v3.0.0 Issues and PRs related to version 3.0.0

Comments

@VachaShah
Copy link
Collaborator

VachaShah commented Jan 17, 2024

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, the annotate_code in gradle task does not add the Generated 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

  1. Created a nested proto message and generate Java code.
  2. Run ./gradlew :server:missingJavadoc.
  3. See error for missing javadoc for nested classes/interfaces.

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):

  • OS: [e.g. iOS]
  • Version [e.g. 22]

Additional context
protocolbuffers/protobuf#42 (comment)

@VachaShah VachaShah added bug Something isn't working untriaged labels Jan 17, 2024
@github-actions github-actions bot added the Other label Jan 17, 2024
@peternied peternied added Build Build Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement. javadocs Anything related to javadocs labels Jan 24, 2024
@peternied
Copy link
Member

[Triage - attendees 1 2]
@VachaShah Thanks for filing.

@reta reta added v3.0.0 Issues and PRs related to version 3.0.0 v2.14.0 labels Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Build Build Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement. javadocs Anything related to javadocs Other v2.14.0 v3.0.0 Issues and PRs related to version 3.0.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants