Browse Source

MINOR: Fix JavaDocs warnings (#6435)

Fix JavaDocs Warning
Reviewers: uozhang Wang <wangguoz@gmail.com>,  Bill Bejeck <bbejeck@gmail.com>
pull/6098/merge
Matthias J. Sax 6 years ago committed by Bill Bejeck
parent
commit
a648ef0b44
  1. 4
      clients/src/main/java/org/apache/kafka/common/config/ConfigDef.java
  2. 2
      clients/src/main/java/org/apache/kafka/common/security/oauthbearer/OAuthBearerExtensionsValidatorCallback.java
  3. 8
      streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
  4. 2
      streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java

4
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_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;)); * 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_default&quot;, &quot;some value&quot;);
* props.put(&quot;config_with_dependents&quot;, &quot;some other 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 * 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 * will be included n the table with the value of the update mode. Default
* mode is "read-only". * 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) { public String toHtmlTable(Map<String, String> dynamicUpdateModes) {
boolean hasUpdateModes = !dynamicUpdateModes.isEmpty(); boolean hasUpdateModes = !dynamicUpdateModes.isEmpty();

2
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() { public Map<String, String> invalidExtensions() {
return Collections.unmodifiableMap(invalidExtensions); return Collections.unmodifiableMap(invalidExtensions);

8
streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java

@ -155,23 +155,23 @@ public class KafkaStreams implements AutoCloseable {
* *
* <pre> * <pre>
* +--------------+ * +--------------+
* +<----- | Created (0) | * +&lt;----- | Created (0) |
* | +-----+--------+ * | +-----+--------+
* | | * | |
* | v * | v
* | +----+--+------+ * | +----+--+------+
* | | Re- | * | | Re- |
* +<----- | Balancing (1)| -------->+ * +&lt;----- | Balancing (1)| --------&gt;+
* | +-----+-+------+ | * | +-----+-+------+ |
* | | ^ | * | | ^ |
* | v | | * | v | |
* | +--------------+ v * | +--------------+ v
* | | Running (2) | -------->+ * | | Running (2) | --------&gt;+
* | +------+-------+ | * | +------+-------+ |
* | | | * | | |
* | v | * | v |
* | +------+-------+ +----+-------+ * | +------+-------+ +----+-------+
* +-----> | Pending |<--- | Error (5) | * +-----&gt; | Pending |&lt;--- | Error (5) |
* | Shutdown (3) | +------------+ * | Shutdown (3) | +------------+
* +------+-------+ * +------+-------+
* | * |

2
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 * 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: * increase {@link ConsumerConfig#MAX_POLL_INTERVAL_MS_CONFIG} using the following guidance:
* <pre> * <pre>
* max.poll.interval.ms > max.block.ms * max.poll.interval.ms &gt; max.block.ms
* </pre> * </pre>
* *
* *

Loading…
Cancel
Save