Repository: camel Updated Branches: refs/heads/camel-2.14.x 185be50d0 -> d9da4d038 refs/heads/master e6b9b857b -> 8a26f04bb
Fixed bunch of java doc warnings of camel-core Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/d9da4d03 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/d9da4d03 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/d9da4d03 Branch: refs/heads/camel-2.14.x Commit: d9da4d0382a75209b1d9ba30ab3c3d42bbf3c3f6 Parents: 185be50 Author: Willem Jiang <[email protected]> Authored: Sun Sep 14 16:10:02 2014 +0800 Committer: Willem Jiang <[email protected]> Committed: Sun Sep 14 19:16:55 2014 +0800 ---------------------------------------------------------------------- .../org/apache/camel/builder/DataFormatClause.java | 2 +- .../org/apache/camel/builder/ExpressionClause.java | 1 - .../camel/builder/ExpressionClauseSupport.java | 2 +- .../apache/camel/component/log/LogComponent.java | 2 +- .../org/apache/camel/model/ThrottleDefinition.java | 16 ++++++++++++++-- .../apache/camel/processor/MulticastProcessor.java | 2 +- .../GroupedExchangeAggregationStrategy.java | 2 +- .../main/java/org/apache/camel/util/HostUtils.java | 2 +- .../org/apache/camel/util/component/ApiMethod.java | 1 - 9 files changed, 20 insertions(+), 10 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/d9da4d03/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java b/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java index 508b9fb..95078d9 100644 --- a/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java +++ b/camel-core/src/main/java/org/apache/camel/builder/DataFormatClause.java @@ -592,7 +592,7 @@ public class DataFormatClause<T extends ProcessorDefinition<?>> { } /** - * @deprecated Use {@link #secureXML(String, Map, boolean, String, String, String, String) instead. + * @deprecated Use {@link #secureXML(String, Map, boolean, String, String, String, String)} instead. * Uses the XML Security data format */ @Deprecated http://git-wip-us.apache.org/repos/asf/camel/blob/d9da4d03/camel-core/src/main/java/org/apache/camel/builder/ExpressionClause.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/builder/ExpressionClause.java b/camel-core/src/main/java/org/apache/camel/builder/ExpressionClause.java index b1f391f..b6af214 100644 --- a/camel-core/src/main/java/org/apache/camel/builder/ExpressionClause.java +++ b/camel-core/src/main/java/org/apache/camel/builder/ExpressionClause.java @@ -779,7 +779,6 @@ public class ExpressionClause<T> extends ExpressionDefinition { * with the specified result type * * @param text the expression to be evaluated - * @param text the expression to be evaluated * @param resultType the return type expected by the expression * @param headerName the name of the header to apply the expression to * @return the builder to continue processing the DSL http://git-wip-us.apache.org/repos/asf/camel/blob/d9da4d03/camel-core/src/main/java/org/apache/camel/builder/ExpressionClauseSupport.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/builder/ExpressionClauseSupport.java b/camel-core/src/main/java/org/apache/camel/builder/ExpressionClauseSupport.java index 2d31a27..5fdc737 100644 --- a/camel-core/src/main/java/org/apache/camel/builder/ExpressionClauseSupport.java +++ b/camel-core/src/main/java/org/apache/camel/builder/ExpressionClauseSupport.java @@ -612,7 +612,7 @@ public class ExpressionClauseSupport<T> { * wrap the token with its ancestor contet, or to unwrap to its element child * @param namespaces the namespace map to the namespace bindings * @param group to group by the given number - * @return + * @return the builder to continue processing the DSL */ public T xtokenize(String path, char mode, Namespaces namespaces, int group) { XMLTokenizerExpression expression = new XMLTokenizerExpression(path); http://git-wip-us.apache.org/repos/asf/camel/blob/d9da4d03/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java b/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java index a46f705..7fad12b 100644 --- a/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java +++ b/camel-core/src/main/java/org/apache/camel/component/log/LogComponent.java @@ -98,7 +98,7 @@ public class LogComponent extends UriEndpointComponent { * {@link Logger} in {@link CamelLogger} * * @param parameters - * @return + * @return the Logger object from the parameter */ protected Logger getLogger(Map<String, Object> parameters) { return getAndRemoveOrResolveReferenceParameter(parameters, "logger", Logger.class); http://git-wip-us.apache.org/repos/asf/camel/blob/d9da4d03/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java b/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java index 9ec13f8..2a14052 100644 --- a/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java +++ b/camel-core/src/main/java/org/apache/camel/model/ThrottleDefinition.java @@ -158,7 +158,7 @@ public class ThrottleDefinition extends ExpressionNode implements ExecutorServic } /** - * Enables asynchronous delay which means the thread will <b>noy</b> block while delaying. + * Enables asynchronous delay which means the thread will <b>no</b> block while delaying. * * @return the builder */ @@ -172,7 +172,7 @@ public class ThrottleDefinition extends ExpressionNode implements ExecutorServic * <p/> * Is by default <tt>false</tt> * - * @param throw the RejectExecutionException if the exchange exceeds the request limit + * @param rejectExecution throw the RejectExecutionException if the exchange exceeds the request limit * @return the builder */ public ThrottleDefinition rejectExecution(boolean rejectExecution) { @@ -180,11 +180,23 @@ public class ThrottleDefinition extends ExpressionNode implements ExecutorServic return this; } + /** + * Sets the ExecutorService which could be used by throttle definition + * + * @param executorService + * @return the builder + */ public ThrottleDefinition executorService(ExecutorService executorService) { setExecutorService(executorService); return this; } + /** + * Sets the ExecutorService which could be used by throttle definition + * + * @param executorServiceRef the reference id of the Executor Service + * @return the builder + */ public ThrottleDefinition executorServiceRef(String executorServiceRef) { setExecutorServiceRef(executorServiceRef); return this; http://git-wip-us.apache.org/repos/asf/camel/blob/d9da4d03/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java b/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java index 30c8a55..1d579cd 100644 --- a/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java +++ b/camel-core/src/main/java/org/apache/camel/processor/MulticastProcessor.java @@ -828,7 +828,7 @@ public class MulticastProcessor extends ServiceSupport implements AsyncProcessor } /** - * Aggregate the {@link Exchange) with the current result. + * Aggregate the {@link Exchange} with the current result. * This method is unsynchronized and is called directly when parallelAggregate is enabled. * In all other cases, this method is called from the doAggregate which is a synchronized method * http://git-wip-us.apache.org/repos/asf/camel/blob/d9da4d03/camel-core/src/main/java/org/apache/camel/processor/aggregate/GroupedExchangeAggregationStrategy.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/processor/aggregate/GroupedExchangeAggregationStrategy.java b/camel-core/src/main/java/org/apache/camel/processor/aggregate/GroupedExchangeAggregationStrategy.java index 2906270..274ce16 100644 --- a/camel-core/src/main/java/org/apache/camel/processor/aggregate/GroupedExchangeAggregationStrategy.java +++ b/camel-core/src/main/java/org/apache/camel/processor/aggregate/GroupedExchangeAggregationStrategy.java @@ -23,7 +23,7 @@ import org.apache.camel.impl.DefaultExchange; /** * Aggregate all exchanges into a single combined Exchange holding all the aggregated exchanges - * in a {@link java.util.List<Exchange>} as the message body. + * in a {@link List} of {@link Exchange} as the message body. * * @version */ http://git-wip-us.apache.org/repos/asf/camel/blob/d9da4d03/camel-core/src/main/java/org/apache/camel/util/HostUtils.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/HostUtils.java b/camel-core/src/main/java/org/apache/camel/util/HostUtils.java index f659a30..2931466 100644 --- a/camel-core/src/main/java/org/apache/camel/util/HostUtils.java +++ b/camel-core/src/main/java/org/apache/camel/util/HostUtils.java @@ -33,7 +33,7 @@ public final class HostUtils { } /** - * Returns a {@link} of {@link InetAddress} per {@link NetworkInterface} as a {@link Map}. + * Returns a {@link Map} of {@link InetAddress} per {@link NetworkInterface}. */ public static Map<String, Set<InetAddress>> getNetworkInterfaceAddresses() { //JVM returns interfaces in a non-predictable order, so to make this more predictable http://git-wip-us.apache.org/repos/asf/camel/blob/d9da4d03/camel-core/src/main/java/org/apache/camel/util/component/ApiMethod.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/util/component/ApiMethod.java b/camel-core/src/main/java/org/apache/camel/util/component/ApiMethod.java index 00a7b5c..a2274bf 100644 --- a/camel-core/src/main/java/org/apache/camel/util/component/ApiMethod.java +++ b/camel-core/src/main/java/org/apache/camel/util/component/ApiMethod.java @@ -21,7 +21,6 @@ import java.util.List; /** * Interface for proxy methods. - * @param <T> */ public interface ApiMethod {
