MINOR: Various javadoc fixes#10272
Merged
Merged
Conversation
- Use consistent options for `javadoc` and `aggregatedJavadoc` - `aggregatedJavadoc` depends on `compileJava` - `connect-api` inherits `options.links` - `streams` and `streams-test-utils` javadoc exclusions should be more specific to avoid unexpected behavior in `aggregatedJavadoc` where the javadoc for multiple modules is generated together
chia7712
reviewed
Mar 6, 2021
chia7712
left a comment
chia7712
left a comment
Member
There was a problem hiding this comment.
@ijuma I'd like to test this patch for docs. However, it seems aggregatedJavadoc was broken (see following output). Do you want to fix it in this patch?
/home/chia7712/kafka/streams/test-utils/src/main/java/org/apache/kafka/streams/TopologyTestDriver.java:44: error: cannot find symbol
import org.apache.kafka.streams.internals.KeyValueStoreFacade;
^
symbol: class KeyValueStoreFacade
location: package org.apache.kafka.streams.internals
/home/chia7712/kafka/streams/test-utils/src/main/java/org/apache/kafka/streams/TopologyTestDriver.java:45: error: cannot find symbol
import org.apache.kafka.streams.internals.WindowStoreFacade;
^
symbol: class WindowStoreFacade
location: package org.apache.kafka.streams.internals
/home/chia7712/kafka/streams/test-utils/src/main/java/org/apache/kafka/streams/TopologyTestDriver.java:69: error: cannot find symbol
import org.apache.kafka.streams.processor.internals.TestDriverProducer;
^
symbol: class TestDriverProducer
location: package org.apache.kafka.streams.processor.internals
/home/chia7712/kafka/streams/test-utils/src/main/java/org/apache/kafka/streams/TopologyTestDriver.java:226: error: cannot find symbol
private final TestDriverProducer testDriverProducer;
^
symbol: class TestDriverProducer
location: class TopologyTestDriver
4 errors
| } | ||
|
|
||
| tasks.withType(Javadoc) { | ||
| // disable the crazy super-strict doclint tool in Java 8 |
Member
There was a problem hiding this comment.
How about keeping those comments?
Member
Author
There was a problem hiding this comment.
It seemed a bit redundant since we only support Java 8+. I can add back something.
Member
Author
|
You have to test with Java 8. I filed https://issues.apache.org/jira/browse/KAFKA-12435 for the Java 11 issue yesterday. It's not clear that there's an easy fix. |
chia7712
approved these changes
Mar 8, 2021
chia7712
left a comment
chia7712
left a comment
Member
There was a problem hiding this comment.
LGTM
aggregatedJavadoc is broken on 2.8, 2.7 and 2.6. Maybe we should backport this patch.
Member
Author
|
Merged to trunk and cherry-picked to 2.8 for now. |
ijuma
added a commit
that referenced
this pull request
Mar 9, 2021
- Use consistent options for `javadoc` and `aggregatedJavadoc` - `aggregatedJavadoc` depends on `compileJava` - `connect-api` inherits `options.links` - `streams` and `streams-test-utils` javadoc exclusions should be more specific to avoid unexpected behavior in `aggregatedJavadoc` when the javadoc for multiple modules is generated together Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
3 tasks
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
javadocandaggregatedJavadocaggregatedJavadocdepends oncompileJavaconnect-apiinheritsoptions.linksstreamsandstreams-test-utilsjavadoc exclusions should be morespecific to avoid unexpected behavior in
aggregatedJavadocwhen thejavadoc for multiple modules is generated together
Committer Checklist (excluded from commit message)