Skip to content
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.

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

MINOR: Fix warnings in streams javadoc #15955

Merged
merged 1 commit into from
May 15, 2024

Conversation

mimaison
Copy link
Member

Fixes the following warnings (./gradlew streams:javadoc):

> Task :streams:javadoc
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/processor/assignment/TaskAssignor.java:74: warning - @param argument "assignment:" is not a parameter name.
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/processor/assignment/TaskAssignor.java:74: warning - @param argument "subscription:" is not a parameter name.
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/processor/assignment/TaskAssignor.java:74: warning - @param argument "error:" is not a parameter name.
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:663: warning - Missing closing '}' character for inline tag: "{@code auto.include.jmx.reporter"
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:663: warning - Tag @link: reference not found: JMX_REPORTER "jmx.reporter"
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:579: warning - Missing closing '}' character for inline tag: "{@code default.windowed.key.serde.inner"
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:587: warning - Missing closing '}' character for inline tag: "{@code default.windowed.value.serde.inner"
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:663: warning - Tag @link: reference not found: JMX_REPORTER "jmx.reporter"
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:663: warning - Tag @link: reference not found: JMX_REPORTER "jmx.reporter"
/Users/mickael/github/kafka/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:663: warning - Tag @link: reference not found: JMX_REPORTER "jmx.reporter"

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

Copy link
Contributor

@chia7712 chia7712 left a comment

Choose a reason for hiding this comment

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

LGTM

@chia7712 chia7712 merged commit 34ec3fa into apache:trunk May 15, 2024
1 check failed
@mjsax
Copy link
Member

mjsax commented May 18, 2024

Thanks for the cleanup! Highly appreciated!

@chia7712 chia7712 mentioned this pull request May 23, 2024
TaiJuWu pushed a commit to TaiJuWu/kafka that referenced this pull request Jun 8, 2024
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
gongxuanzhang pushed a commit to gongxuanzhang/kafka that referenced this pull request Jun 12, 2024
Reviewers: Chia-Ping Tsai <chia7712@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants