kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gwens...@apache.org
Subject kafka git commit: KAFKA-2906: Fix Connect javadocs, restrict only to api subproject, and clean up javadoc warnings.
Date Sun, 29 Nov 2015 21:27:03 GMT
Repository: kafka
Updated Branches:
  refs/heads/0.9.0 e934a107f -> cbddb0709


KAFKA-2906: Fix Connect javadocs, restrict only to api subproject, and clean up javadoc warnings.

Author: Ewen Cheslack-Postava <me@ewencp.org>

Reviewers: Gwen Shapira

Closes #599 from ewencp/kafka-2906-connect-javadocs

(cherry picked from commit 75c7abd82628b7aae026a662ad0395d1f9c8536b)
Signed-off-by: Gwen Shapira <cshapi@gmail.com>


Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/cbddb070
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/cbddb070
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/cbddb070

Branch: refs/heads/0.9.0
Commit: cbddb0709df712e9496aa783e801969168c1cbec
Parents: e934a10
Author: Ewen Cheslack-Postava <me@ewencp.org>
Authored: Mon Nov 30 05:26:32 2015 +0800
Committer: Gwen Shapira <cshapi@gmail.com>
Committed: Mon Nov 30 05:26:51 2015 +0800

----------------------------------------------------------------------
 build.gradle                                    |  8 +++----
 .../kafka/connect/data/ConnectSchema.java       |  2 +-
 .../kafka/connect/data/SchemaBuilder.java       | 24 ++++++++++----------
 .../apache/kafka/connect/source/SourceTask.java |  2 +-
 .../apache/kafka/connect/storage/Converter.java |  2 +-
 5 files changed, 19 insertions(+), 19 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/cbddb070/build.gradle
----------------------------------------------------------------------
diff --git a/build.gradle b/build.gradle
index d99eeec..a259cb8 100644
--- a/build.gradle
+++ b/build.gradle
@@ -604,7 +604,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) {
@@ -665,7 +665,7 @@ project(':connect:json') {
   }
 
   javadoc {
-    include "**/org/apache/kafka/connect/*"
+    enabled = false
   }
 
   tasks.create(name: "copyDependantLibs", type: Copy) {
@@ -733,7 +733,7 @@ project(':connect:runtime') {
   }
 
   javadoc {
-    include "**/org/apache/kafka/connect/*"
+    enabled = false
   }
 
   tasks.create(name: "copyDependantLibs", type: Copy) {
@@ -799,7 +799,7 @@ project(':connect:file') {
   }
 
   javadoc {
-    include "**/org/apache/kafka/connect/*"
+    enabled = false
   }
 
   tasks.create(name: "copyDependantLibs", type: Copy) {

http://git-wip-us.apache.org/repos/asf/kafka/blob/cbddb070/connect/api/src/main/java/org/apache/kafka/connect/data/ConnectSchema.java
----------------------------------------------------------------------
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 cb31ca0..c73dafc 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 class ConnectSchema implements Schema {
 
 
     /**
-     * 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

http://git-wip-us.apache.org/repos/asf/kafka/blob/cbddb070/connect/api/src/main/java/org/apache/kafka/connect/data/SchemaBuilder.java
----------------------------------------------------------------------
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 36cbf91..b063c51 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 class SchemaBuilder implements Schema {
     // 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 class SchemaBuilder implements Schema {
     // 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 class SchemaBuilder implements Schema {
 
     /**
      * @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 class SchemaBuilder implements Schema {
     /**
      * @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);

http://git-wip-us.apache.org/repos/asf/kafka/blob/cbddb070/connect/api/src/main/java/org/apache/kafka/connect/source/SourceTask.java
----------------------------------------------------------------------
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 5110504..802fcdd 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 abstract class SourceTask implements Task {
      *
      * 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();
 }

http://git-wip-us.apache.org/repos/asf/kafka/blob/cbddb070/connect/api/src/main/java/org/apache/kafka/connect/storage/Converter.java
----------------------------------------------------------------------
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 158ddb1..c2fda2b 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);
 


Mime
View raw message