Skip to content

MINOR: Various javadoc fixes #10272

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.

Sign up for GitHub

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

Merged
ijuma merged 2 commits into from
Mar 9, 2021
Merged

MINOR: Various javadoc fixes #10272

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f662c7b
MINOR: Various javadoc fixes
ijuma Mar 5, 2021
d272ab0
Add comment about doclint
ijuma Mar 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,6 @@ allprojects {
}
}

tasks.withType(Javadoc) {
// disable the crazy super-strict doclint tool in Java 8

@chia7712 chia7712 Mar 6, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about keeping those comments?

@ijuma ijuma Mar 8, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seemed a bit redundant since we only support Java 8+. I can add back something.

// noinspection SpellCheckingInspection
options.addStringOption('Xdoclint:none', '-quiet')
}

}

ext {
Expand Down Expand Up @@ -471,6 +465,14 @@ subprojects {
options.charSet = 'UTF-8'
options.docEncoding = 'UTF-8'
options.encoding = 'UTF-8'
// Turn off doclint for now, see https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html for rationale
options.addStringOption('Xdoclint:none', '-quiet')

// The URL structure was changed to include the locale after Java 8
if (JavaVersion.current().isJava11Compatible())
options.links "https://docs.oracle.com/en/java/javase/${JavaVersion.current().majorVersion}/docs/api/"
else
options.links "https://docs.oracle.com/javase/8/docs/api/"
}

task systemTestLibs(dependsOn: jar)
Expand Down Expand Up @@ -1476,7 +1478,7 @@ project(':streams') {

javadoc {
include "**/org/apache/kafka/streams/**"
exclude "**/internals/**"
exclude "**/org/apache/kafka/streams/internals/**", "**/org/apache/kafka/streams/**/internals/**"
}

tasks.create(name: "copyDependantLibs", type: Copy) {
Expand Down Expand Up @@ -1614,7 +1616,7 @@ project(':streams:test-utils') {

javadoc {
include "**/org/apache/kafka/streams/test/**"
exclude "**/internals/**"
exclude "**/org/apache/kafka/streams/internals/**", "**/org/apache/kafka/streams/**/internals/**"
}

tasks.create(name: "copyDependantLibs", type: Copy) {
Expand Down Expand Up @@ -1941,11 +1943,6 @@ project(':connect:api') {

javadoc {
include "**/org/apache/kafka/connect/**" // needed for the `aggregatedJavadoc` task
// The URL structure was changed to include the locale after Java 8
if (JavaVersion.current().isJava11Compatible())
options.links "https://docs.oracle.com/en/java/javase/${JavaVersion.current().majorVersion}/docs/api/"
else
options.links "https://docs.oracle.com/javase/8/docs/api/"
}

tasks.create(name: "copyDependantLibs", type: Copy) {
Expand Down Expand Up @@ -2309,12 +2306,19 @@ project(':connect:mirror-client') {
}
}

task aggregatedJavadoc(type: Javadoc) {
task aggregatedJavadoc(type: Javadoc, dependsOn: compileJava) {
def projectsWithJavadoc = subprojects.findAll { it.javadoc.enabled }
source = projectsWithJavadoc.collect { it.sourceSets.main.allJava }
classpath = files(projectsWithJavadoc.collect { it.sourceSets.main.compileClasspath })
includes = projectsWithJavadoc.collectMany { it.javadoc.getIncludes() }
excludes = projectsWithJavadoc.collectMany { it.javadoc.getExcludes() }

options.charSet = 'UTF-8'
options.docEncoding = 'UTF-8'
options.encoding = 'UTF-8'
// Turn off doclint for now, see https://blog.joda.org/2014/02/turning-off-doclint-in-jdk-8-javadoc.html for rationale
options.addStringOption('Xdoclint:none', '-quiet')

// The URL structure was changed to include the locale after Java 8
if (JavaVersion.current().isJava11Compatible())
options.links "https://docs.oracle.com/en/java/javase/${JavaVersion.current().majorVersion}/docs/api/"
Expand Down