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/5f269bd8 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5f269bd8 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5f269bd8 Branch: refs/heads/master Commit: 5f269bd8219264a1e3855711b08391209c569c0b Parents: 0c1d4b7 Author: Claus Ibsen <[email protected]> Authored: Sun Dec 27 13:20:37 2015 +0100 Committer: Claus Ibsen <[email protected]> Committed: Sun Dec 27 18:25:25 2015 +0100 ---------------------------------------------------------------------- .../java/org/apache/camel/component/bean/BeanEndpoint.java | 2 +- .../apache/camel/component/disruptor/DisruptorEndpoint.java | 5 ++--- .../java/org/apache/camel/component/dns/DnsEndpoint.java | 3 +++ .../org/apache/camel/component/docker/DockerEndpoint.java | 4 ++-- .../java/org/apache/camel/component/dozer/DozerEndpoint.java | 3 +++ .../org/apache/camel/component/dropbox/DropboxEndpoint.java | 3 +++ .../java/org/apache/camel/component/ejb/EjbEndpoint.java | 3 +++ .../camel/component/elasticsearch/ElasticsearchEndpoint.java | 2 +- .../java/org/apache/camel/component/elsql/ElsqlEndpoint.java | 3 +++ .../camel/component/eventadmin/EventAdminEndpoint.java | 2 +- .../java/org/apache/camel/component/exec/ExecEndpoint.java | 8 +------- 11 files changed, 23 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java index a42f664..2de7d53 100644 --- a/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/bean/BeanEndpoint.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * The <a href="http://camel.apache.org/bean.html";>Bean Component</a> is for invoking Java beans from Camel. + * The <a href="http://camel.apache.org/bean.html";>bean component</a> is for invoking Java beans from Camel. */ @UriEndpoint(scheme = "bean", title = "Bean", syntax = "bean:beanName", producerOnly = true, label = "core,java") public class BeanEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java b/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java index 33debc7..2ddc6b1 100644 --- a/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java +++ b/components/camel-disruptor/src/main/java/org/apache/camel/component/disruptor/DisruptorEndpoint.java @@ -43,9 +43,8 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * An implementation of the <a href="https://github.com/sirchia/camel-disruptor";>Disruptor component</a> - * for asynchronous SEDA exchanges on an - * <a href="https://github.com/LMAX-Exchange/disruptor";>LMAX Disruptor</a> within a CamelContext + * The disruptor component provides asynchronous SEDA behavior much as the standard SEDA Component, + * but utilizes a Disruptor instead of a BlockingQueue utilized by the standard SEDA. */ @ManagedResource(description = "Managed Disruptor Endpoint") @UriEndpoint(scheme = "disruptor,disruptor-vm", title = "Disruptor,Disruptor VM", syntax = "disruptor:name", consumerClass = DisruptorConsumer.class, label = "endpoint") http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java b/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java index 76778af..bcd27ac 100644 --- a/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java +++ b/components/camel-dns/src/main/java/org/apache/camel/component/dns/DnsEndpoint.java @@ -25,6 +25,9 @@ import org.apache.camel.spi.Metadata; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriPath; +/** + * To lookup domain information and run DNS queries using DNSJava. + */ @UriEndpoint(scheme = "dns", title = "DNS", syntax = "dns:dnsType", producerOnly = true, label = "networking") public class DnsEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java index de40ca3..09d80f6 100644 --- a/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java +++ b/components/camel-docker/src/main/java/org/apache/camel/component/docker/DockerEndpoint.java @@ -28,9 +28,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * Represents a Docker endpoint. + * The docker component is used for managing Docker containers. */ -@UriEndpoint(scheme = "docker", title = "Docker", syntax = "docker:operation", consumerClass = DockerEventsConsumer.class, label = "container,cloud,platform") +@UriEndpoint(scheme = "docker", title = "Docker", syntax = "docker:operation", consumerClass = DockerEventsConsumer.class, label = "container,cloud,management,platform") public class DockerEndpoint extends DefaultEndpoint { @UriParam http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java b/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java index eae218c..2d48d11 100644 --- a/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java +++ b/components/camel-dozer/src/main/java/org/apache/camel/component/dozer/DozerEndpoint.java @@ -35,6 +35,9 @@ import org.dozer.DozerBeanMapper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * The dozer component provides the ability to map between Java beans using the Dozer mapping library. + */ @UriEndpoint(scheme = "dozer", title = "Dozer", syntax = "dozer:name", producerOnly = true, label = "transformation") public class DozerEndpoint extends DefaultEndpoint { private static final Logger LOG = LoggerFactory.getLogger(DozerEndpoint.class); http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java b/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java index f8025e6..d796e3c 100755 --- a/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java +++ b/components/camel-dropbox/src/main/java/org/apache/camel/component/dropbox/DropboxEndpoint.java @@ -37,6 +37,9 @@ import org.slf4j.LoggerFactory; import static org.apache.camel.component.dropbox.util.DropboxConstants.POLL_CONSUMER_DELAY; +/** + * For uploading, downloading and managing files, folders, groups, collaborations, etc on dropbox DOT com. + */ @UriEndpoint(scheme = "dropbox", title = "Dropbox", syntax = "dropbox:operation", consumerClass = DropboxScheduledPollConsumer.class, label = "api,file") public class DropboxEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java b/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java index 417ea94..6a5030f 100644 --- a/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java +++ b/components/camel-ejb/src/main/java/org/apache/camel/component/ejb/EjbEndpoint.java @@ -20,6 +20,9 @@ import org.apache.camel.Component; import org.apache.camel.component.bean.BeanEndpoint; import org.apache.camel.spi.UriEndpoint; +/** + * The ejb component is for invoking EJB Java beans from Camel. + */ @UriEndpoint(scheme = "ejb", title = "EJB", syntax = "ejb:beanName", producerOnly = true, label = "endpoint,java") public class EjbEndpoint extends BeanEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java index 18842b3..6138019 100644 --- a/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java +++ b/components/camel-elasticsearch/src/main/java/org/apache/camel/component/elasticsearch/ElasticsearchEndpoint.java @@ -39,7 +39,7 @@ import org.slf4j.LoggerFactory; import static org.elasticsearch.node.NodeBuilder.nodeBuilder; /** - * Represents an Elasticsearch endpoint. + * The elasticsearch component is used for interfacing with ElasticSearch server. */ @UriEndpoint(scheme = "elasticsearch", title = "Elasticsearch", syntax = "elasticsearch:clusterName", producerOnly = true, label = "monitoring,search") public class ElasticsearchEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java b/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java index 80bf8e3..07abfad 100644 --- a/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java +++ b/components/camel-elsql/src/main/java/org/apache/camel/component/elsql/ElsqlEndpoint.java @@ -42,6 +42,9 @@ import org.springframework.jdbc.core.namedparam.EmptySqlParameterSource; import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate; import org.springframework.jdbc.core.namedparam.SqlParameterSource; +/** + * The elsql component is an extension to the existing SQL Component that uses ElSql to define the SQL queries. + */ @UriEndpoint(scheme = "elsql", title = "SQL", syntax = "elsql:elsqlName:resourceUri", consumerClass = ElsqlConsumer.class, label = "database,sql") public class ElsqlEndpoint extends DefaultSqlEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java b/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java index 3970ffc..82659d5 100644 --- a/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java +++ b/components/camel-eventadmin/src/main/java/org/apache/camel/component/eventadmin/EventAdminEndpoint.java @@ -25,7 +25,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * EventAdmin endpoint + * The eventadmin component can be used in an OSGi environment to receive OSGi EventAdmin events and process them. */ @UriEndpoint(scheme = "eventadmin", title = "OSGi EventAdmin", syntax = "eventadmin:topic", consumerClass = EventAdminConsumer.class, label = "eventbus") public class EventAdminEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/5f269bd8/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java b/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java index e6cf4f2..46dfc18 100644 --- a/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java +++ b/components/camel-exec/src/main/java/org/apache/camel/component/exec/ExecEndpoint.java @@ -28,13 +28,7 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; /** - * The endpoint utilizes an {@link ExecCommandExecutor} to execute a system - * command when it receives message exchanges. - * - * @see ExecBinding - * @see ExecCommandExecutor - * @see ExecCommand - * @see ExecResult + * The exec component can be used to execute OS system commands. */ @UriEndpoint(scheme = "exec", title = "Exec", syntax = "exec:executable", producerOnly = true, label = "system") public class ExecEndpoint extends DefaultEndpoint {
