CAMEL-8561: Better component docs summary of components - we use javadoc from the endpoint class instead of component so its in the same source file as @UriEndpoint.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/87f2194d Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/87f2194d Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/87f2194d Branch: refs/heads/master Commit: 87f2194dea18fc07b7d1f4f845ca5296aeaf55ab Parents: ea48809 Author: Claus Ibsen <[email protected]> Authored: Sun Dec 27 13:57:17 2015 +0100 Committer: Claus Ibsen <[email protected]> Committed: Sun Dec 27 18:25:26 2015 +0100 ---------------------------------------------------------------------- .../org/apache/camel/component/grape/GrapeEndpoint.groovy | 3 +++ .../camel/component/guava/eventbus/GuavaEventBusEndpoint.java | 3 +-- .../camel/component/hazelcast/HazelcastDefaultEndpoint.java | 3 +++ .../java/org/apache/camel/component/hbase/HBaseEndpoint.java | 2 +- .../main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java | 3 +++ .../java/org/apache/camel/component/hdfs2/HdfsEndpoint.java | 3 +++ .../org/apache/camel/component/hipchat/HipchatComponent.java | 2 +- .../org/apache/camel/component/hipchat/HipchatEndpoint.java | 5 +---- .../main/java/org/apache/camel/component/http/HttpEndpoint.java | 4 +--- .../java/org/apache/camel/component/http4/HttpEndpoint.java | 4 +--- 10 files changed, 18 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy ---------------------------------------------------------------------- diff --git a/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy b/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy index 9e0c730..e845f0c 100644 --- a/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy +++ b/components/camel-grape/src/main/groovy/org/apache/camel/component/grape/GrapeEndpoint.groovy @@ -26,6 +26,9 @@ import org.apache.camel.spi.UriEndpoint import static groovy.grape.Grape.grab import static org.apache.camel.component.grape.MavenCoordinates.parseMavenCoordinates +/** + * The grape component allows you to fetch, load and manage additional jars when CamelContext is running. + */ @UriEndpoint(scheme = "grape", syntax = "grape:defaultCoordinates", title = "Grape", producerOnly = true, label = "management,deployment") class GrapeEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java b/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java index e7db21d..74f1325 100644 --- a/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java +++ b/components/camel-guava-eventbus/src/main/java/org/apache/camel/component/guava/eventbus/GuavaEventBusEndpoint.java @@ -30,8 +30,7 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.CamelContextHelper; /** - * Guava EventBus (http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/eventbus/EventBus.html) - * endpoint. Can create both producer and consumer ends of the route. + * The guava-eventbus component provides integration bridge between Camel and Google Guava EventBus. */ @UriEndpoint(scheme = "guava-eventbus", title = "Guava EventBus", syntax = "guava-eventbus:eventBusRef", consumerClass = GuavaEventBusConsumer.class, label = "eventbus") public class GuavaEventBusEndpoint extends DefaultEndpoint implements MultipleConsumersSupport { http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java b/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java index 5cdee44..dec3f48 100644 --- a/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java +++ b/components/camel-hazelcast/src/main/java/org/apache/camel/component/hazelcast/HazelcastDefaultEndpoint.java @@ -27,6 +27,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * The hazelcast component allows you to work with the Hazelcast distributed data grid / cache. + */ @UriEndpoint(scheme = "hazelcast", title = "Hazelcast", syntax = "hazelcast:command:cacheName", consumerClass = HazelcastDefaultConsumer.class, label = "cache,datagrid") public abstract class HazelcastDefaultEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java b/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java index 00bf8df..2ccfde6 100644 --- a/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java +++ b/components/camel-hbase/src/main/java/org/apache/camel/component/hbase/HBaseEndpoint.java @@ -37,7 +37,7 @@ import org.apache.hadoop.hbase.filter.Filter; import org.apache.hadoop.security.UserGroupInformation; /** - * Represents an HBase endpoint. + * For reading/writing from/to an HBase store (Hadoop database) */ @UriEndpoint(scheme = "hbase", title = "HBase", syntax = "hbase:tableName", consumerClass = HBaseConsumer.class, label = "hadoop") public class HBaseEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java b/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java index 0aeb4a9..ad02148 100644 --- a/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java +++ b/components/camel-hdfs/src/main/java/org/apache/camel/component/hdfs/HdfsEndpoint.java @@ -27,6 +27,9 @@ import org.apache.camel.impl.DefaultEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; +/** + * For reading/writing from/to an HDFS filesystem using Hadoop 1.x + */ @UriEndpoint(scheme = "hdfs", title = "HDFS", syntax = "hdfs:hostName:port/path", consumerClass = HdfsConsumer.class, label = "hadoop,file") public class HdfsEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java b/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java index 257670f..f32884d 100644 --- a/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java +++ b/components/camel-hdfs2/src/main/java/org/apache/camel/component/hdfs2/HdfsEndpoint.java @@ -27,6 +27,9 @@ import org.apache.camel.impl.DefaultEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; +/** + * For reading/writing from/to an HDFS filesystem using Hadoop 2.x + */ @UriEndpoint(scheme = "hdfs2", title = "HDFS2", syntax = "hdfs2:hostName:port/path", consumerClass = HdfsConsumer.class, label = "hadoop,file") public class HdfsEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java b/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java index a47cfa2..10f634f 100644 --- a/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java +++ b/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatComponent.java @@ -53,7 +53,7 @@ public class HipchatComponent extends UriEndpointComponent { throw new HipchatException("OAuth 2 auth token must be specified"); } parseUri(uri, endpoint); - LOG.info("Using Hipchat API URL: " + endpoint.getConfiguration().hipChatUrl()); + LOG.debug("Using Hipchat API URL: {}", endpoint.getConfiguration().hipChatUrl()); return endpoint; } http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java b/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java index 87680c2..0210df7 100644 --- a/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java +++ b/components/camel-hipchat/src/main/java/org/apache/camel/component/hipchat/HipchatEndpoint.java @@ -19,15 +19,12 @@ package org.apache.camel.component.hipchat; import org.apache.camel.Consumer; import org.apache.camel.Processor; import org.apache.camel.Producer; -import org.apache.camel.impl.DefaultEndpoint; import org.apache.camel.impl.ScheduledPollEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; /** - * Represents a Hipchat endpoint. + * The hipchat component supports producing and consuming messages from/to Hipchat service. */ @UriEndpoint(scheme = "hipchat", title = "Hipchat", syntax = "hipchat:protocol:host:port", consumerClass = HipchatConsumer.class, label = "api,cloud") public class HipchatEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java b/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java index 98df503..4106975 100644 --- a/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java +++ b/components/camel-http/src/main/java/org/apache/camel/component/http/HttpEndpoint.java @@ -37,9 +37,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Represents a <a href="http://camel.apache.org/http.html";>HTTP endpoint</a> - * - * @version + * For calling out to external HTTP servers using Apache HTTP Client 3.x. */ @UriEndpoint(scheme = "http,https", title = "HTTP,HTTPS", syntax = "http:httpUri", producerOnly = true, label = "http") public class HttpEndpoint extends HttpCommonEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/87f2194d/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java b/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java index b589e65..7dfeaf3 100644 --- a/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java +++ b/components/camel-http4/src/main/java/org/apache/camel/component/http4/HttpEndpoint.java @@ -42,9 +42,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Represents a <a href="http://camel.apache.org/http.html";>HTTP endpoint</a> - * - * @version + * For calling out to external HTTP servers using Apache HTTP Client 4.x */ @UriEndpoint(scheme = "http4,http4s", title = "HTTP4,HTTP4S", syntax = "http4:httpUri", producerOnly = true, label = "http") public class HttpEndpoint extends HttpCommonEndpoint {
