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 generated types #13199

Merged
merged 1 commit into from
Apr 15, 2024

Conversation

reta
Copy link
Collaborator

@reta reta commented Apr 15, 2024

Description

There are generators (like protobuf) which add @javax.annotation.Generated to top level classes only. The missing javadoc verification does not support that and fails with the error.

@javax.annotation.Generated(value="protoc", comments="annotations:FetchSearchResultProto.java.pb.meta")
public final class FetchSearchResultProto {
  public interface FetchSearchResultOrBuilder extends
  // ...
  }
}

Related Issues

Closes #11913

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
  • Commits are signed per the DCO using --signoff
  • Commit changes are listed out in CHANGELOG.md file (See: Changelog)
  • Public documentation issue/PR created

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@github-actions github-actions bot added bug Something isn't working Build Build Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement. javadocs Anything related to javadocs Other labels Apr 15, 2024
@reta reta mentioned this pull request Apr 15, 2024
8 tasks
Copy link
Contributor

Compatibility status:

Checks if related components are compatible with change 17271fa

Incompatible components

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/flow-framework.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/geospatial.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/performance-analyzer.git]

Copy link
Contributor

✅ Gradle check result for 17271fa: SUCCESS

@reta reta merged commit 6447dd1 into opensearch-project:main Apr 15, 2024
78 checks passed
@reta reta added the backport 2.x Backport to 2.x branch label Apr 15, 2024
opensearch-trigger-bot bot pushed a commit that referenced this pull request Apr 15, 2024
Signed-off-by: Andriy Redko <[email protected]>
(cherry picked from commit 6447dd1)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
owaiskazi19 pushed a commit that referenced this pull request Apr 15, 2024
…13200)

(cherry picked from commit 6447dd1)

Signed-off-by: Andriy Redko <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.x Backport to 2.x branch bug Something isn't working Build Build Tasks/Gradle Plugin, groovy scripts, build tools, Javadoc enforcement. javadocs Anything related to javadocs Other skip-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Fix missing javadocs error for nested classes generated using protobuf
2 participants