[Backport] [2.x] Add support for ignoring missing Javadoc on generated code using annotation (# 7264) (#7604) #7779
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…tation (# 7264) (opensearch-project#7604) * Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com> (cherry picked from commit 0921ad7)
reta
requested review from
anasalkouz,
andrross,
Bukhtawar,
CEHENKLE,
dblock,
gbbafna,
setiah,
kartg,
kotwanikunal,
mch2,
nknize,
owaiskazi19,
Rishikesh1159,
ryanbogan,
saratvemulapalli,
shwetathareja,
dreamer-89,
tlfeng,
VachaShah and
dbwiddis
as code owners
Gradle Check (Jenkins) Run Completed with:
|
Codecov Report
@@ Coverage Diff @@
## 2.x #7779 +/- ##
============================================
- Coverage 70.96% 70.58% -0.38%
+ Complexity 56726 56431 -295
============================================
Files 4665 4665
Lines 267674 267674
Branches 39634 39634
============================================
- Hits 189955 188944 -1011
- Misses 61637 62456 +819
- Partials 16082 16274 +192 |
kotwanikunal
approved these changes
May 26, 2023
|
@reta Should this be backported to 2.8? |
Personally I would not do that due to new dependency (javax-annotations), it could break other plugins at the last moment |
gaiksaya
pushed a commit
to gaiksaya/OpenSearch
that referenced
this pull request
Jun 26, 2023
…tation (# 7264) (opensearch-project#7604) (opensearch-project#7779) * Allow wild cards for missingJavadoc (# 7264) It can be tedious and error prone to have to specify individual source files of generated code that does not follow OpenSearch standards. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Allow wild cards for missingJavadoc (# 7264) Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Address a comment Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Add support for ignoring missing Javadoc using annotation Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Fix a dependency issue for build-tool:reaper. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Undo support for wildcards for ignoring missing Javadoc. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove dependency on jboss from doc-tools by using class names. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Remove the missingJavadoc Gradle task that is no longer needed. Signed-off-by: Austin Lee <austin.t.lee@gmail.com> * Update changelog Signed-off-by: Austin Lee <austin.t.lee@gmail.com> --------- Signed-off-by: Austin Lee <austin.t.lee@gmail.com> (cherry picked from commit 0921ad7) Co-authored-by: Austin Lee <austin.t.lee@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport of #7604 to
2.x