kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bbej...@apache.org
Subject [kafka] branch trunk updated: MINOR: Fix JavaDocs warnings (#6435)
Date Wed, 13 Mar 2019 16:17:04 GMT
This is an automated email from the ASF dual-hosted git repository.

bbejeck pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new a648ef0  MINOR: Fix JavaDocs warnings (#6435)
a648ef0 is described below

commit a648ef0b44e9c3efbee3d66fc7dae85fea24a74b
Author: Matthias J. Sax <mjsax@apache.org>
AuthorDate: Wed Mar 13 09:16:48 2019 -0700

    MINOR: Fix JavaDocs warnings (#6435)
    
    Fix JavaDocs Warning
    Reviewers: uozhang Wang <wangguoz@gmail.com>,  Bill Bejeck <bbejeck@gmail.com>
---
 .../src/main/java/org/apache/kafka/common/config/ConfigDef.java   | 4 ++--
 .../oauthbearer/OAuthBearerExtensionsValidatorCallback.java       | 2 +-
 streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java  | 8 ++++----
 streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java | 2 +-
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java b/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java
index 7669f1d..1259882 100644
--- a/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java
+++ b/clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java
@@ -53,7 +53,7 @@ import java.util.regex.Pattern;
  * defs.define(&quot;config_with_validator&quot;, Type.INT, 42, Range.atLeast(0),
&quot;Configuration with user provided validator.&quot;);
  * defs.define(&quot;config_with_dependents&quot;, Type.INT, &quot;Configuration
with dependents.&quot;, &quot;group&quot;, 1, &quot;Config With Dependents&quot;,
Arrays.asList(&quot;config_with_default&quot;,&quot;config_with_validator&quot;));
  *
- * Map&lt;String, String&gt; props = new HashMap&lt;&gt();
+ * Map&lt;String, String&gt; props = new HashMap&lt;&gt;();
  * props.put(&quot;config_with_default&quot;, &quot;some value&quot;);
  * props.put(&quot;config_with_dependents&quot;, &quot;some other value&quot;);
  *
@@ -1133,7 +1133,7 @@ public class ConfigDef {
      * If <code>dynamicUpdateModes</code> is non-empty, a "Dynamic Update Mode"
column
      * will be included n the table with the value of the update mode. Default
      * mode is "read-only".
-     * @param dynamicUpdateModes Config name -> update mode mapping
+     * @param dynamicUpdateModes Config name -&gt; update mode mapping
      */
     public String toHtmlTable(Map<String, String> dynamicUpdateModes) {
         boolean hasUpdateModes = !dynamicUpdateModes.isEmpty();
diff --git a/clients/src/main/java/org/apache/kafka/common/security/oauthbearer/OAuthBearerExtensionsValidatorCallback.java
b/clients/src/main/java/org/apache/kafka/common/security/oauthbearer/OAuthBearerExtensionsValidatorCallback.java
index 97ac4d9..eab208b 100644
--- a/clients/src/main/java/org/apache/kafka/common/security/oauthbearer/OAuthBearerExtensionsValidatorCallback.java
+++ b/clients/src/main/java/org/apache/kafka/common/security/oauthbearer/OAuthBearerExtensionsValidatorCallback.java
@@ -76,7 +76,7 @@ public class OAuthBearerExtensionsValidatorCallback implements Callback
{
     }
 
     /**
-     * @return An immutable {@link Map} consisting of the name->error messages of extensions
which failed validation
+     * @return An immutable {@link Map} consisting of the name-&gt;error messages of
extensions which failed validation
      */
     public Map<String, String> invalidExtensions() {
         return Collections.unmodifiableMap(invalidExtensions);
diff --git a/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java b/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
index 2d1aa79..4f15dea 100644
--- a/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
+++ b/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
@@ -155,23 +155,23 @@ public class KafkaStreams implements AutoCloseable {
      *
      * <pre>
      *                 +--------------+
-     *         +<----- | Created (0)  |
+     *         +&lt;----- | Created (0)  |
      *         |       +-----+--------+
      *         |             |
      *         |             v
      *         |       +----+--+------+
      *         |       | Re-          |
-     *         +<----- | Balancing (1)| -------->+
+     *         +&lt;----- | Balancing (1)| --------&gt;+
      *         |       +-----+-+------+          |
      *         |             | ^                 |
      *         |             v |                 |
      *         |       +--------------+          v
-     *         |       | Running (2)  | -------->+
+     *         |       | Running (2)  | --------&gt;+
      *         |       +------+-------+          |
      *         |              |                  |
      *         |              v                  |
      *         |       +------+-------+     +----+-------+
-     *         +-----> | Pending      |<--- | Error (5)  |
+     *         +-----&gt; | Pending      |&lt;--- | Error (5)  |
      *                 | Shutdown (3) |     +------------+
      *                 +------+-------+
      *                        |
diff --git a/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java b/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
index b756ba2..2ba7312 100644
--- a/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
+++ b/streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java
@@ -102,7 +102,7 @@ import static org.apache.kafka.common.requests.IsolationLevel.READ_COMMITTED;
  * When increasing {@link ProducerConfig#MAX_BLOCK_MS_CONFIG} to be more resilient to non-available
brokers you should also
  * increase {@link ConsumerConfig#MAX_POLL_INTERVAL_MS_CONFIG} using the following guidance:
  * <pre>
- *     max.poll.interval.ms > max.block.ms
+ *     max.poll.interval.ms &gt; max.block.ms
  * </pre>
  *
  *


Mime
View raw message