Skip to content

Commit

Permalink
Clarify and add links on future action for temporary exclusions
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Widdis <widdis@gmail.com>
  • Loading branch information
dbwiddis committed Jul 13, 2022
1 parent 5458f5a commit 28c5441
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,17 @@ task requireJavadoc(type: JavaExec) {
classpath = configurations.requireJavadoc
args "src/main/java"
args "--dont-require-private=true"
// temporary, the netty4 package will eventually be in OpenSearch main repo
// the netty4 package will eventually be published to mavenCentral
// See https://github.com/opensearch-project/OpenSearch/issues/3118
args "--exclude=netty4"
// temporary until require-javadoc:1.0.4 allows suppressing getters and setters
// require-javadoc:1.0.4 will allow suppressing getters and setters
// tracking in https://github.com/plume-lib/require-javadoc/issues/143
// prefer using --dont-require-trivial-properties before adding more exceptions here
args "--dont-require=[sg]et[Hostaddress|Hostport|Extensionname]"
}
check.dependsOn requireJavadoc

// this task checks for the content/tags of javadocs
// this task checks the content/tags of existing javadocs
task javadocStrict(type: Javadoc) {
group = 'Documentation'
description = 'Run Javadoc in strict mode: with -Xdoclint:all, on all members.'
Expand All @@ -94,7 +96,7 @@ task javadocStrict(type: Javadoc) {
options.addStringOption('Xdoclint:all', '-quiet')
options.memberLevel = JavadocMemberLevel.PRIVATE

// temporary, the netty4 package will eventually be in OpenSearch main repo
// the netty4 package will eventually be published to mavenCentral
// See https://github.com/opensearch-project/OpenSearch/issues/3118
exclude 'org/opensearch/sdk/netty4'
}
Expand Down

0 comments on commit 28c5441

Please sign in to comment.