From 75c7abd82628b7aae026a662ad0395d1f9c8536b Mon Sep 17 00:00:00 2001 From: Ewen Cheslack-Postava Date: Mon, 30 Nov 2015 05:26:32 +0800 Subject: [PATCH] KAFKA-2906: Fix Connect javadocs, restrict only to api subproject, and clean up javadoc warnings. Author: Ewen Cheslack-Postava Reviewers: Gwen Shapira Closes #599 from ewencp/kafka-2906-connect-javadocs --- build.gradle | 8 +++---- .../kafka/connect/data/ConnectSchema.java | 2 +- .../kafka/connect/data/SchemaBuilder.java | 24 +++++++++---------- .../kafka/connect/source/SourceTask.java | 2 +- .../kafka/connect/storage/Converter.java | 2 +- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/build.gradle b/build.gradle index 4eba282c2e6b0..b15f13bb04619 100644 --- a/build.gradle +++ b/build.gradle @@ -667,7 +667,7 @@ project(':connect:api') { } javadoc { - include "**/org/apache/kafka/connect/*" + options.links "http://docs.oracle.com/javase/7/docs/api/" } tasks.create(name: "copyDependantLibs", type: Copy) { @@ -728,7 +728,7 @@ project(':connect:json') { } javadoc { - include "**/org/apache/kafka/connect/*" + enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { @@ -797,7 +797,7 @@ project(':connect:runtime') { } javadoc { - include "**/org/apache/kafka/connect/*" + enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { @@ -863,7 +863,7 @@ project(':connect:file') { } javadoc { - include "**/org/apache/kafka/connect/*" + enabled = false } tasks.create(name: "copyDependantLibs", type: Copy) { diff --git a/connect/api/src/main/java/org/apache/kafka/connect/data/ConnectSchema.java b/connect/api/src/main/java/org/apache/kafka/connect/data/ConnectSchema.java index cb31ca097b216..c73dafc3637e5 100644 --- a/connect/api/src/main/java/org/apache/kafka/connect/data/ConnectSchema.java +++ b/connect/api/src/main/java/org/apache/kafka/connect/data/ConnectSchema.java @@ -295,7 +295,7 @@ public String toString() { /** - * Get the {@link Type} associated with the the given class. + * Get the {@link Schema.Type} associated with the the given class. * * @param klass the Class to * @return the corresponding type, nor null if there is no matching type diff --git a/connect/api/src/main/java/org/apache/kafka/connect/data/SchemaBuilder.java b/connect/api/src/main/java/org/apache/kafka/connect/data/SchemaBuilder.java index 36cbf91ad11ab..b063c51fae458 100644 --- a/connect/api/src/main/java/org/apache/kafka/connect/data/SchemaBuilder.java +++ b/connect/api/src/main/java/org/apache/kafka/connect/data/SchemaBuilder.java @@ -236,63 +236,63 @@ public static SchemaBuilder type(Type type) { // Primitive types /** - * @return a new {@link Type#INT8} SchemaBuilder + * @return a new {@link Schema.Type#INT8} SchemaBuilder */ public static SchemaBuilder int8() { return new SchemaBuilder(Type.INT8); } /** - * @return a new {@link Type#INT16} SchemaBuilder + * @return a new {@link Schema.Type#INT16} SchemaBuilder */ public static SchemaBuilder int16() { return new SchemaBuilder(Type.INT16); } /** - * @return a new {@link Type#INT32} SchemaBuilder + * @return a new {@link Schema.Type#INT32} SchemaBuilder */ public static SchemaBuilder int32() { return new SchemaBuilder(Type.INT32); } /** - * @return a new {@link Type#INT64} SchemaBuilder + * @return a new {@link Schema.Type#INT64} SchemaBuilder */ public static SchemaBuilder int64() { return new SchemaBuilder(Type.INT64); } /** - * @return a new {@link Type#FLOAT32} SchemaBuilder + * @return a new {@link Schema.Type#FLOAT32} SchemaBuilder */ public static SchemaBuilder float32() { return new SchemaBuilder(Type.FLOAT32); } /** - * @return a new {@link Type#FLOAT64} SchemaBuilder + * @return a new {@link Schema.Type#FLOAT64} SchemaBuilder */ public static SchemaBuilder float64() { return new SchemaBuilder(Type.FLOAT64); } /** - * @return a new {@link Type#BOOLEAN} SchemaBuilder + * @return a new {@link Schema.Type#BOOLEAN} SchemaBuilder */ public static SchemaBuilder bool() { return new SchemaBuilder(Type.BOOLEAN); } /** - * @return a new {@link Type#STRING} SchemaBuilder + * @return a new {@link Schema.Type#STRING} SchemaBuilder */ public static SchemaBuilder string() { return new SchemaBuilder(Type.STRING); } /** - * @return a new {@link Type#BYTES} SchemaBuilder + * @return a new {@link Schema.Type#BYTES} SchemaBuilder */ public static SchemaBuilder bytes() { return new SchemaBuilder(Type.BYTES); @@ -302,7 +302,7 @@ public static SchemaBuilder bytes() { // Structs /** - * @return a new {@link Type#STRUCT} SchemaBuilder + * @return a new {@link Schema.Type#STRUCT} SchemaBuilder */ public static SchemaBuilder struct() { return new SchemaBuilder(Type.STRUCT); @@ -349,7 +349,7 @@ public Field field(String fieldName) { /** * @param valueSchema the schema for elements of the array - * @return a new {@link Type#ARRAY} SchemaBuilder + * @return a new {@link Schema.Type#ARRAY} SchemaBuilder */ public static SchemaBuilder array(Schema valueSchema) { SchemaBuilder builder = new SchemaBuilder(Type.ARRAY); @@ -360,7 +360,7 @@ public static SchemaBuilder array(Schema valueSchema) { /** * @param keySchema the schema for keys in the map * @param valueSchema the schema for values in the map - * @return a new {@link Type#MAP} SchemaBuilder + * @return a new {@link Schema.Type#MAP} SchemaBuilder */ public static SchemaBuilder map(Schema keySchema, Schema valueSchema) { SchemaBuilder builder = new SchemaBuilder(Type.MAP); diff --git a/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java b/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java index 5110504ec5f84..802fcdd6bbec2 100644 --- a/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java +++ b/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java @@ -76,7 +76,7 @@ public void commit() throws InterruptedException { * * For example, if a task uses a {@link java.nio.channels.Selector} to receive data over the network, this method * could set a flag that will force {@link #poll()} to exit immediately and invoke - * {@link java.nio.channels.Selector#wakeup()} to interrupt any ongoing requests. + * {@link java.nio.channels.Selector#wakeup() wakeup()} to interrupt any ongoing requests. */ public abstract void stop(); } diff --git a/connect/api/src/main/java/org/apache/kafka/connect/storage/Converter.java b/connect/api/src/main/java/org/apache/kafka/connect/storage/Converter.java index 158ddb1c00ec6..c2fda2be32e79 100644 --- a/connect/api/src/main/java/org/apache/kafka/connect/storage/Converter.java +++ b/connect/api/src/main/java/org/apache/kafka/connect/storage/Converter.java @@ -43,7 +43,7 @@ public interface Converter { * @param topic the topic associated with the data * @param schema the schema for the value * @param value the value to convert - * @return + * @return the serialized value */ byte[] fromConnectData(String topic, Schema schema, Object value);