[Javadoc] Add missing package-info.java files to server #3128
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
In preparation for re-enabling the missingJavadoc gradle task this change adds in the missing package-info.java files to the server folder. For now general javadocs are added to these files with the intent to clean up with better descriptions over time. Signed-off-by: Nicholas Walter Knize <nknize@apache.org>
nknize
added
documentation
reta
reviewed
May 2, 2022
| @@ -162,7 +162,6 @@ configure([ | |||
| project(":qa:os"), | |||
| project(":qa:wildfly"), | |||
| project(":rest-api-spec"), | |||
| project(":server"), | |||
There was a problem hiding this comment.
This change is not very unclear: we do exactly what the same thing by extracting configure(project(":server")) into separate configuration block.
There was a problem hiding this comment.
It's starting to isolate the projects that will have missingJavadoc reenabled. To test this locally comment out isExcluded = true and uncomment the following two lines.
// TODO: reenable after fixing missing javadocs
// javadocMissingLevel = "class"
This is done intentional for incremental progress toward re-enabling. Otherwise I'm going to have to (un)copypasta this for each incremental PR
reta
approved these changes
May 2, 2022
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
May 2, 2022
In preparation for re-enabling the missingJavadoc gradle task this change adds in the missing package-info.java files to the server folder. For now general javadocs are added to these files with the intent to clean up with better descriptions over time. Signed-off-by: Nicholas Walter Knize <nknize@apache.org> (cherry picked from commit 2146827)
dblock
pushed a commit
that referenced
this pull request
May 3, 2022
In preparation for re-enabling the missingJavadoc gradle task this change adds in the missing package-info.java files to the server folder. For now general javadocs are added to these files with the intent to clean up with better descriptions over time. Signed-off-by: Nicholas Walter Knize <nknize@apache.org> (cherry picked from commit 2146827) Co-authored-by: Nick Knize <nknize@apache.org>
nknize
added a commit
that referenced
this pull request
May 13, 2022
In preparation for re-enabling the missingJavadoc gradle task this change adds in the missing package-info.java files to the server folder. For now general javadocs are added to these files with the intent to clean up with better descriptions over time. Signed-off-by: Nicholas Walter Knize <nknize@apache.org> (cherry picked from commit 2146827)
nknize
pushed a commit
that referenced
this pull request
May 13, 2022
In preparation for re-enabling the missingJavadoc gradle task this change adds in the missing package-info.java files to the server folder. For now general javadocs are added to these files with the intent to clean up with better descriptions over time. Signed-off-by: Nicholas Walter Knize <nknize@apache.org> (cherry picked from commit 2146827)
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.
In preparation for re-enabling the
missingJavadocgradle task this change addsin the missing package-info.java files to the server folder. For now general
javadocs are added to these files with the intent to clean up with better
descriptions over time.
This change also adds support for
@OpenSearch.internaland@OpenSearch.experimentaljavadoc tags for marking classes andmethods that should not be extended by "external" plugins.
relates #221
relates #2868