diff --git a/apm-commons/apm-datacarrier/src/main/java/org/skywalking/apm/commons/datacarrier/DataCarrier.java b/apm-commons/apm-datacarrier/src/main/java/org/skywalking/apm/commons/datacarrier/DataCarrier.java index aa037f8ad..b2213e91c 100644 --- a/apm-commons/apm-datacarrier/src/main/java/org/skywalking/apm/commons/datacarrier/DataCarrier.java +++ b/apm-commons/apm-datacarrier/src/main/java/org/skywalking/apm/commons/datacarrier/DataCarrier.java @@ -45,10 +45,10 @@ public class DataCarrier { /** * set a new IDataPartitioner. - * It will cover the current one or default one.(Default is {@link SimpleRollingPartitioner)} + * It will cover the current one or default one.(Default is {@link SimpleRollingPartitioner} * - * @param dataPartitioner - * @return + * @param dataPartitioner implementation + * @return {@link DataCarrier} instance itself */ public DataCarrier setPartitioner(IDataPartitioner dataPartitioner) { this.channels.setPartitioner(dataPartitioner); @@ -57,9 +57,10 @@ public class DataCarrier { /** * override the strategy at runtime. - * Notice, {@link Channels} will override several channels one by one. + * Notice, {@link Channels} will override several channels one by one. * - * @param strategy + * @param strategy {@link BufferStrategy} + * @return {@link DataCarrier} instance itself */ public DataCarrier setBufferStrategy(BufferStrategy strategy) { this.channels.setStrategy(strategy); @@ -67,9 +68,9 @@ public class DataCarrier { } /** - * produce data to buffer, using the givven {@link BufferStrategy}. + * produce data to buffer, using the given {@link BufferStrategy}. * - * @param data + * @param data inserted into the channel. * @return false means produce data failure. The data will not be consumed. */ public boolean produce(T data) { @@ -84,10 +85,11 @@ public class DataCarrier { /** * set consumers to this Carrier. - * consumer begin to run when {@link DataCarrier#produce(T)} begin to work. + * consumer begin to run when {@link DataCarrier{@link #produce(Object)}} begin to work. * * @param consumerClass class of consumer * @param num number of consumer threads + * @return {@link DataCarrier} instance itself */ public DataCarrier consume(Class> consumerClass, int num) { if (consumerPool != null) { @@ -100,11 +102,11 @@ public class DataCarrier { /** * set consumers to this Carrier. - * consumer begin to run when {@link DataCarrier#produce(T)} begin to work. + * consumer begin to run when produce begin to work. * * @param consumer single instance of consumer, all consumer threads will all use this instance. * @param num number of consumer threads - * @return + * @return {@link DataCarrier} instance itself */ public DataCarrier consume(IConsumer consumer, int num) { if (consumerPool != null) { diff --git a/apm-commons/apm-datacarrier/src/main/java/org/skywalking/apm/commons/datacarrier/buffer/Channels.java b/apm-commons/apm-datacarrier/src/main/java/org/skywalking/apm/commons/datacarrier/buffer/Channels.java index f419af334..b375f1093 100644 --- a/apm-commons/apm-datacarrier/src/main/java/org/skywalking/apm/commons/datacarrier/buffer/Channels.java +++ b/apm-commons/apm-datacarrier/src/main/java/org/skywalking/apm/commons/datacarrier/buffer/Channels.java @@ -66,7 +66,7 @@ public class Channels { * override the strategy at runtime. Notice, this will override several channels one by one. So, when running * setStrategy, each channel may use different BufferStrategy * - * @param strategy + * @param strategy {@link BufferStrategy} */ public void setStrategy(BufferStrategy strategy) { for (Buffer buffer : bufferChannels) { @@ -77,7 +77,7 @@ public class Channels { /** * get channelSize * - * @return + * @return channel size */ public int getChannelSize() { return this.bufferChannels.length; diff --git a/pom.xml b/pom.xml index 1fd8affe7..cffa55678 100644 --- a/pom.xml +++ b/pom.xml @@ -266,6 +266,26 @@ 2.4 + + org.apache.maven.plugins + maven-javadoc-plugin + 2.8.1 + + + attach-javadocs + + jar + + + + + true + ${project.build.sourceEncoding} + ${project.build.sourceEncoding} + ${project.build.sourceEncoding} + -Xdoclint:none + + org.codehaus.mojo versions-maven-plugin