Repository: kafka Updated Branches: refs/heads/trunk 7a1466392 -> f931febc8
MINOR: A few javadoc fixes Author: Jason Gustafson <ja...@confluent.io> Reviewers: Guozhang Wang <wangg...@gmail.com> Closes #4076 from hachikuji/javadoc-fixes Project: http://git-wip-us.apache.org/repos/asf/kafka/repo Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/f931febc Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/f931febc Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/f931febc Branch: refs/heads/trunk Commit: f931febc8c4b74baa522a593f16df84a0b05bd99 Parents: 7a14663 Author: Jason Gustafson <ja...@confluent.io> Authored: Mon Oct 16 17:49:35 2017 -0700 Committer: Jason Gustafson <ja...@confluent.io> Committed: Mon Oct 16 17:49:35 2017 -0700 ---------------------------------------------------------------------- .../main/java/org/apache/kafka/clients/admin/AdminClient.java | 4 ++-- .../org/apache/kafka/clients/admin/DescribeLogDirsOptions.java | 2 +- .../org/apache/kafka/clients/admin/DescribeLogDirsResult.java | 2 +- .../kafka/clients/admin/DescribeReplicaLogDirsOptions.java | 2 +- .../java/org/apache/kafka/clients/producer/KafkaProducer.java | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/kafka/blob/f931febc/clients/src/main/java/org/apache/kafka/clients/admin/AdminClient.java ---------------------------------------------------------------------- diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/AdminClient.java b/clients/src/main/java/org/apache/kafka/clients/admin/AdminClient.java index fd695f9..3f56399 100644 --- a/clients/src/main/java/org/apache/kafka/clients/admin/AdminClient.java +++ b/clients/src/main/java/org/apache/kafka/clients/admin/AdminClient.java @@ -247,7 +247,7 @@ public abstract class AdminClient implements AutoCloseable { public abstract DescribeAclsResult describeAcls(AclBindingFilter filter, DescribeAclsOptions options); /** - * This is a convenience method for #{@link AdminClient#createAcls(Collection<AclBinding>, CreateAclsOptions)} with + * This is a convenience method for #{@link AdminClient#createAcls(Collection, CreateAclsOptions)} with * default options. See the overload for more details. * * This operation is supported by brokers with version 0.11.0.0 or higher. @@ -276,7 +276,7 @@ public abstract class AdminClient implements AutoCloseable { public abstract CreateAclsResult createAcls(Collection<AclBinding> acls, CreateAclsOptions options); /** - * This is a convenience method for #{@link AdminClient#deleteAcls(Collection<AclBinding>, DeleteAclsOptions)} with default options. + * This is a convenience method for #{@link AdminClient#deleteAcls(Collection, DeleteAclsOptions)} with default options. * See the overload for more details. * * This operation is supported by brokers with version 0.11.0.0 or higher. http://git-wip-us.apache.org/repos/asf/kafka/blob/f931febc/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsOptions.java ---------------------------------------------------------------------- diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsOptions.java b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsOptions.java index 48711bf..5f6352c 100644 --- a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsOptions.java +++ b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsOptions.java @@ -23,7 +23,7 @@ import java.util.Collection; /** - * Options for {@link AdminClient#describeLogDirs(Collection<Integer>)} + * Options for {@link AdminClient#describeLogDirs(Collection)} * * The API of this class is evolving, see {@link AdminClient} for details. */ http://git-wip-us.apache.org/repos/asf/kafka/blob/f931febc/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsResult.java ---------------------------------------------------------------------- diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsResult.java b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsResult.java index 907b48d..de186fd 100644 --- a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsResult.java +++ b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeLogDirsResult.java @@ -27,7 +27,7 @@ import org.apache.kafka.common.requests.DescribeLogDirsResponse.LogDirInfo; /** - * The result of the {@link AdminClient#describeLogDirs(Collection<Integer>)} call. + * The result of the {@link AdminClient#describeLogDirs(Collection)} call. * * The API of this class is evolving, see {@link AdminClient} for details. */ http://git-wip-us.apache.org/repos/asf/kafka/blob/f931febc/clients/src/main/java/org/apache/kafka/clients/admin/DescribeReplicaLogDirsOptions.java ---------------------------------------------------------------------- diff --git a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeReplicaLogDirsOptions.java b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeReplicaLogDirsOptions.java index 943795c..c0924ef 100644 --- a/clients/src/main/java/org/apache/kafka/clients/admin/DescribeReplicaLogDirsOptions.java +++ b/clients/src/main/java/org/apache/kafka/clients/admin/DescribeReplicaLogDirsOptions.java @@ -21,7 +21,7 @@ import org.apache.kafka.common.annotation.InterfaceStability; import java.util.Collection; /** - * Options for {@link AdminClient#describeReplicaLogDirs(Collection<org.apache.kafka.common.TopicPartitionReplica>)}. + * Options for {@link AdminClient#describeReplicaLogDirs(Collection)}. * * The API of this class is evolving, see {@link AdminClient} for details. */ http://git-wip-us.apache.org/repos/asf/kafka/blob/f931febc/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java ---------------------------------------------------------------------- diff --git a/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java b/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java index b6c0a53..bb05e2c 100644 --- a/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java +++ b/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java @@ -746,7 +746,7 @@ public class KafkaProducer<K, V> implements Producer<K, V> { * @param callback A user-supplied callback to execute when the record has been acknowledged by the server (null * indicates no callback) * - * @throws AuthenticationException if authentication fails. See the exception for more details + * @throws org.apache.kafka.common.errors.AuthenticationException if authentication fails. See the exception for more details * @throws IllegalStateException if a transactional.id has been configured and no transaction has been started * @throws InterruptException If the thread is interrupted while blocked * @throws SerializationException If the key or value are not valid objects given the configured serializers @@ -969,7 +969,7 @@ public class KafkaProducer<K, V> implements Producer<K, V> { /** * Get the partition metadata for the given topic. This can be used for custom partitioning. - * @throws AuthenticationException if authentication fails. See the exception for more details + * @throws org.apache.kafka.common.errors.AuthenticationException if authentication fails. See the exception for more details * @throws InterruptException If the thread is interrupted while blocked */ @Override