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/31162f9c Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/31162f9c Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/31162f9c Branch: refs/heads/master Commit: 31162f9c0141ae6fe0a67719a90f23ea35fde324 Parents: bbbdb64 Author: Claus Ibsen <[email protected]> Authored: Sun Dec 27 12:43:59 2015 +0100 Committer: Claus Ibsen <[email protected]> Committed: Sun Dec 27 18:25:24 2015 +0100 ---------------------------------------------------------------------- .../apache/camel/component/dataset/DataSetEndpoint.java | 2 +- .../org/apache/camel/component/ahc/ws/WsComponent.java | 2 +- .../org/apache/camel/component/ahc/ws/WsEndpoint.java | 3 +++ .../java/org/apache/camel/component/ahc/AhcEndpoint.java | 3 +++ .../org/apache/camel/component/amqp/AMQPEndpoint.java | 4 +++- .../org/apache/camel/component/apns/ApnsEndpoint.java | 3 +++ .../component/atmosphere/websocket/WebsocketEndpoint.java | 2 +- .../org/apache/camel/component/atom/AtomEndpoint.java | 3 +++ .../org/apache/camel/component/avro/AvroComponent.java | 3 --- .../org/apache/camel/component/avro/AvroEndpoint.java | 3 +++ .../component/bean/validator/BeanValidatorEndpoint.java | 5 +++++ .../camel/component/beanstalk/BeanstalkEndpoint.java | 3 +++ .../java/org/apache/camel/component/box/BoxEndpoint.java | 2 +- .../org/apache/camel/component/cache/CacheEndpoint.java | 10 ++++++++-- .../camel/component/cassandra/CassandraEndpoint.java | 5 +++-- .../org/apache/camel/component/chunk/ChunkEndpoint.java | 3 +++ .../org/apache/camel/component/cmis/CMISEndpoint.java | 2 +- .../src/main/java/org/apache/camel/coap/CoAPEndpoint.java | 2 +- .../org/apache/camel/component/cometd/CometdEndpoint.java | 5 ++++- .../apache/camel/component/context/ContextEndpoint.java | 9 +++++++++ .../apache/camel/component/couchdb/CouchDbEndpoint.java | 3 +++ .../camel/component/crypto/DigitalSignatureEndpoint.java | 3 +++ .../java/org/apache/camel/component/cxf/CxfEndpoint.java | 7 +------ .../apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java | 3 +++ .../camel/tools/apt/EndpointAnnotationProcessor.java | 2 +- 25 files changed, 70 insertions(+), 22 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java ---------------------------------------------------------------------- diff --git a/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java b/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java index 10653ec..7f9d5ca 100644 --- a/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java +++ b/camel-core/src/main/java/org/apache/camel/component/dataset/DataSetEndpoint.java @@ -38,7 +38,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * The DataSet component provides a mechanism to easily perform load & soak testing of your system. + * The dataset component provides a mechanism to easily perform load & soak testing of your system. * * It works by allowing you to create DataSet instances both as a source of messages and as a way to assert that the data set is received. * Camel will use the throughput logger when sending dataset's. http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java b/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java index 7d557a5..6fe85b9 100644 --- a/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java +++ b/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsComponent.java @@ -22,7 +22,7 @@ import org.apache.camel.component.ahc.AhcComponent; import org.apache.camel.component.ahc.AhcEndpoint; /** - * To exchange data with external Websocket servers using <a href="http://github.com/sonatype/async-http-client";>Async Http Client</a> + * To exchange data with external Websocket servers using <a href="http://github.com/sonatype/async-http-client";>Async Http Client</a> */ public class WsComponent extends AhcComponent { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java b/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java index 77ed754..7f2c8a3 100644 --- a/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java +++ b/components/camel-ahc-ws/src/main/java/org/apache/camel/component/ahc/ws/WsEndpoint.java @@ -38,6 +38,9 @@ import org.apache.camel.spi.UriParam; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * To exchange data with external Websocket servers using <a href="http://github.com/sonatype/async-http-client";>Async Http Client</a> + */ @UriEndpoint(scheme = "ahc-ws,ahc-wss", extendsScheme = "ahc,ahc", title = "AHC Websocket,AHC Secure Websocket", syntax = "ahc-ws:httpUri", consumerClass = WsConsumer.class, label = "websocket") public class WsEndpoint extends AhcEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java b/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java index eb42d0a..001740f 100644 --- a/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java +++ b/components/camel-ahc/src/main/java/org/apache/camel/component/ahc/AhcEndpoint.java @@ -34,6 +34,9 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; import org.apache.camel.util.jsse.SSLContextParameters; +/** + * To call external HTTP services using <a href="http://github.com/sonatype/async-http-client";>Async Http Client</a> + */ @UriEndpoint(scheme = "ahc", title = "AHC", syntax = "ahc:httpUri", producerOnly = true, label = "http") public class AhcEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java index a06fee8..ec6e95a 100644 --- a/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java +++ b/components/camel-amqp/src/main/java/org/apache/camel/component/amqp/AMQPEndpoint.java @@ -21,7 +21,9 @@ import org.apache.camel.component.jms.JmsEndpoint; import org.apache.camel.spi.UriEndpoint; /** - * AMQP endpoint. This class extends JmsEndpoint because it uses Apache Qpid JMS-compatible client for + * Messaging with AMQP protocol using Apache QPid Client. + * + * This class extends JmsEndpoint because it uses Apache Qpid JMS-compatible client for * performing the AMQP connectivity. */ @UriEndpoint(scheme = "amqp", extendsScheme = "jms", title = "AMQP", http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java b/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java index e859c01..180b066 100644 --- a/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java +++ b/components/camel-apns/src/main/java/org/apache/camel/component/apns/ApnsEndpoint.java @@ -29,6 +29,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * For sending notifications to Apple iOS devices + */ @UriEndpoint(scheme = "apns", title = "APNS", syntax = "apns:name", consumerClass = ApnsConsumer.class, label = "eventbus,mobile") public class ApnsEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java b/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java index cdb7ff2..170658d 100644 --- a/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java +++ b/components/camel-atmosphere-websocket/src/main/java/org/apache/camel/component/atmosphere/websocket/WebsocketEndpoint.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * + * To exchange data with external Websocket clients using Atmosphere */ @UriEndpoint(scheme = "atmosphere-websocket", extendsScheme = "servlet", title = "Atmosphere Websocket", syntax = "atmosphere-websocket:servicePath", consumerClass = WebsocketConsumer.class, label = "websocket") http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java index d5600f4..92dc434 100644 --- a/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java +++ b/components/camel-atom/src/main/java/org/apache/camel/component/atom/AtomEndpoint.java @@ -26,6 +26,9 @@ import org.apache.camel.component.feed.FeedEndpoint; import org.apache.camel.component.feed.FeedPollingConsumer; import org.apache.camel.spi.UriEndpoint; +/** + * The atom component is used for consuming Atom RSS feeds. + */ @UriEndpoint(scheme = "atom", title = "Atom", syntax = "atom:feedUri", consumerOnly = true, consumerClass = FeedPollingConsumer.class, label = "rss") public class AtomEndpoint extends FeedEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java ---------------------------------------------------------------------- diff --git a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java index 6406af2..108348b 100644 --- a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java +++ b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroComponent.java @@ -30,9 +30,6 @@ import org.apache.camel.Endpoint; import org.apache.camel.impl.UriEndpointComponent; import org.apache.camel.util.URISupport; -/** - * Working with Apache Avro for data serialization. - */ public class AvroComponent extends UriEndpointComponent { private AvroConfiguration configuration; http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java index a24e937..8ea5720 100644 --- a/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java +++ b/components/camel-avro/src/main/java/org/apache/camel/component/avro/AvroEndpoint.java @@ -28,6 +28,9 @@ import org.apache.camel.impl.DefaultEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; +/** + * Working with Apache Avro for data serialization. + */ @UriEndpoint(scheme = "avro", title = "Avro", syntax = "avro:transport:host:port/messageName", consumerClass = AvroConsumer.class, label = "messaging,transformation") public abstract class AvroEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java b/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java index 7faaab4..bec6729 100644 --- a/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java +++ b/components/camel-bean-validator/src/main/java/org/apache/camel/component/bean/validator/BeanValidatorEndpoint.java @@ -35,6 +35,11 @@ import org.apache.camel.util.PlatformHelper; import static org.apache.camel.component.bean.validator.ValidatorFactories.buildValidatorFactory; +/** + * The Validator component performs bean validation of the message body using the Java Bean Validation API. + * + * Camel uses the reference implementation, which is Hibernate Validator. + */ @UriEndpoint(scheme = "bean-validator", title = "Bean Validator", syntax = "bean-validator:label", producerOnly = true, label = "validation") public class BeanValidatorEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java b/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java index be7bfbe..3fe4f77 100644 --- a/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java +++ b/components/camel-beanstalk/src/main/java/org/apache/camel/component/beanstalk/BeanstalkEndpoint.java @@ -33,6 +33,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * The beanstalk component is used for job retrieval and post-processing of Beanstalk jobs. + */ @UriEndpoint(scheme = "beanstalk", title = "Beanstalk", syntax = "beanstalk:connectionSettings", consumerClass = BeanstalkConsumer.class, label = "messaging") public class BeanstalkEndpoint extends ScheduledPollEndpoint { final ConnectionSettings conn; http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java b/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java index 89219d8..1b987b3 100644 --- a/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java +++ b/components/camel-box/src/main/java/org/apache/camel/component/box/BoxEndpoint.java @@ -37,7 +37,7 @@ import org.apache.camel.util.component.ApiMethod; import org.apache.camel.util.component.ApiMethodPropertiesHelper; /** - * Represents a Box endpoint. + * For uploading, downloading and managing files, folders, groups, collaborations, etc on box DOT com. */ @UriEndpoint(scheme = "box", title = "Box", syntax = "box:apiName/methodName", consumerClass = BoxConsumer.class, consumerPrefix = "consumer", label = "api,file,cloud") public class BoxEndpoint extends AbstractApiEndpoint<BoxApiName, BoxConfiguration> { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java b/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java index fd42b57..45335f3 100755 --- a/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java +++ b/components/camel-cache/src/main/java/org/apache/camel/component/cache/CacheEndpoint.java @@ -28,14 +28,20 @@ import org.apache.camel.Message; import org.apache.camel.Processor; import org.apache.camel.Producer; import org.apache.camel.impl.DefaultEndpoint; -import org.apache.camel.impl.DefaultExchange; -import org.apache.camel.impl.DefaultMessage; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.util.ObjectHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * The cache component enables you to perform caching operations using EHCache as the Cache Implementation. + * + * The cache itself is created on demand or if a cache of that name already exists then it is simply utilized with its original settings. + * This component supports producer and event based consumer endpoints. + * The Cache consumer is an event based consumer and can be used to listen and respond to specific cache activities. + * If you need to perform selections from a pre-existing cache, use the processors defined for the cache component. + */ @UriEndpoint(scheme = "cache", title = "EHCache", syntax = "cache:cacheName", consumerClass = CacheConsumer.class, label = "cache") public class CacheEndpoint extends DefaultEndpoint { private static final Logger LOG = LoggerFactory.getLogger(CacheEndpoint.class); http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java b/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java index 95ab660..6aa6abf 100644 --- a/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java +++ b/components/camel-cassandraql/src/main/java/org/apache/camel/component/cassandra/CassandraEndpoint.java @@ -21,7 +21,6 @@ import com.datastax.driver.core.ConsistencyLevel; import com.datastax.driver.core.PreparedStatement; import com.datastax.driver.core.ResultSet; import com.datastax.driver.core.Session; -import com.datastax.driver.core.policies.LoadBalancingPolicy; import org.apache.camel.Component; import org.apache.camel.Consumer; @@ -37,7 +36,9 @@ import org.apache.camel.utils.cassandra.CassandraLoadBalancingPolicies; import org.apache.camel.utils.cassandra.CassandraSessionHolder; /** - * Cassandra 2 CQL3 endpoint + * The cql component aims at integrating Cassandra 2.0+ using the CQL3 API (not the Thrift API). + * + * It's based on Cassandra Java Driver provided by DataStax. */ @UriEndpoint(scheme = "cql", title = "Cassandra CQL", syntax = "cql:beanRef:hosts:port/keyspace", consumerClass = CassandraConsumer.class, label = "database,nosql") public class CassandraEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java b/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java index 30edf0f..2d37586 100644 --- a/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java +++ b/components/camel-chunk/src/main/java/org/apache/camel/component/chunk/ChunkEndpoint.java @@ -40,6 +40,9 @@ import static org.apache.camel.component.chunk.ChunkConstants.CHUNK_LAYER_SEPARA import static org.apache.camel.component.chunk.ChunkConstants.CHUNK_RESOURCE_URI; import static org.apache.camel.component.chunk.ChunkConstants.CHUNK_TEMPLATE; +/** + * Generates a response using a Chunk template + */ @UriEndpoint(scheme = "chunk", title = "Chunk", syntax = "chunk:resourceUri", producerOnly = true, label = "transformation") public class ChunkEndpoint extends ResourceEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java b/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java index bc700cc..c66f7b9 100644 --- a/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java +++ b/components/camel-cmis/src/main/java/org/apache/camel/component/cmis/CMISEndpoint.java @@ -24,7 +24,7 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * Represents a CMIS endpoint. + * The cmis component uses the Apache Chemistry client API and allows you to add/read nodes to/from a CMIS compliant content repositories. */ @UriEndpoint(scheme = "cmis", title = "CMIS", syntax = "cmis:url", consumerClass = CMISConsumer.class, label = "cms,database") public class CMISEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java b/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java index 758a329..7976d53 100644 --- a/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java +++ b/components/camel-coap/src/main/java/org/apache/camel/coap/CoAPEndpoint.java @@ -28,7 +28,7 @@ import org.apache.camel.spi.UriPath; import org.eclipse.californium.core.CoapServer; /** - * Represents a CoAP endpoint. + * The coap component is used for sending and receiving messages from COAP capable devices. */ @UriEndpoint(scheme = "coap", title = "CoAP", syntax = "coap:uri", consumerClass = CoAPConsumer.class, label = "iot") public class CoAPEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java index 43d2a35..a20b3b4 100644 --- a/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java +++ b/components/camel-cometd/src/main/java/org/apache/camel/component/cometd/CometdEndpoint.java @@ -31,7 +31,10 @@ import org.apache.camel.spi.UriPath; import org.apache.camel.util.ObjectHelper; /** - * Endpoint for Camel Cometd. + * The cometd component is a transport for working with the Jetty implementation of the cometd/bayeux protocol. + * + * Using this component in combination with the dojo toolkit library it's possible to push Camel messages directly + * into the browser using an AJAX based mechanism. */ @UriEndpoint(scheme = "cometd,cometds", title = "CometD", syntax = "cometd:host:port/channelName", consumerClass = CometdConsumer.class, label = "websocket") public class CometdEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java b/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java index 49dfddd..36ad929 100644 --- a/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java +++ b/components/camel-context/src/main/java/org/apache/camel/component/context/ContextEndpoint.java @@ -27,6 +27,15 @@ import org.apache.camel.spi.Metadata; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriPath; +/** + * The context component allows to send/receive messages between Camel routes in a black box way. + * + * The context component allows you to create new Camel Components from a CamelContext with a number of + * routes which is then treated as a black box, allowing you to refer to the local endpoints within the component + * from other CamelContexts. + * It is similar to the Routebox component in idea, though the Context component tries to be really simple for end users; + * just a simple convention over configuration approach to refer to local endpoints inside the CamelContext Component. + */ @UriEndpoint(scheme = "context", title = "Camel Context", syntax = "context:contextId:localEndpointUrl", label = "endpoint") public class ContextEndpoint extends DefaultEndpoint implements DelegateEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java b/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java index 231d95a..005ad4d 100644 --- a/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java +++ b/components/camel-couchdb/src/main/java/org/apache/camel/component/couchdb/CouchDbEndpoint.java @@ -30,6 +30,9 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; import org.lightcouch.CouchDbClient; +/** + * The couchdb component is used for integrate with CouchDB databases. + */ @UriEndpoint(scheme = "couchdb", title = "CouchDB", syntax = "couchdb:protocol:hostname:port/database", consumerClass = CouchDbConsumer.class, label = "database,nosql") public class CouchDbEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java b/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java index a33dedc..a390e3e 100644 --- a/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java +++ b/components/camel-crypto/src/main/java/org/apache/camel/component/crypto/DigitalSignatureEndpoint.java @@ -31,6 +31,9 @@ import org.apache.camel.impl.DefaultEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; +/** + * The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE). + */ @UriEndpoint(scheme = "crypto", title = "Crypto (Java Cryptographic Extension)", syntax = "crypto:cryptoOperation", producerOnly = true, label = "security,transformation") public class DigitalSignatureEndpoint extends DefaultEndpoint { @UriParam http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java b/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java index db78e81..c462321 100644 --- a/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java +++ b/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/CxfEndpoint.java @@ -108,13 +108,8 @@ import org.apache.cxf.wsdl.WSDLManager; import org.slf4j.Logger; import org.slf4j.LoggerFactory; - - /** - * Defines the <a href="http://camel.apache.org/cxf.html";>CXF Endpoint</a>. - * It contains a list of properties for CXF endpoint including {@link DataFormat}, - * {@link CxfBinding}, and {@link HeaderFilterStrategy}. The default DataFormat - * mode is {@link DataFormat#POJO}. + * The cxf component is used for SOAP WebServices using Apache CXF. */ @UriEndpoint(scheme = "cxf", title = "CXF", syntax = "cxf:beanId:address", consumerClass = CxfConsumer.class, label = "soap,webservice") public class CxfEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware, Service, Cloneable { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java b/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java index c3251fa..21b6ef8 100644 --- a/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java +++ b/components/camel-cxf/src/main/java/org/apache/camel/component/cxf/jaxrs/CxfRsEndpoint.java @@ -56,6 +56,9 @@ import org.apache.cxf.message.Message; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * The cxfrs component is used for JAX-RS REST services using Apache CXF. + */ @UriEndpoint(scheme = "cxfrs", title = "CXF-RS", syntax = "cxfrs:beanId:address", consumerClass = CxfRsConsumer.class, label = "rest") public class CxfRsEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware, Service { http://git-wip-us.apache.org/repos/asf/camel/blob/31162f9c/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java ---------------------------------------------------------------------- diff --git a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java index ba05e20..b9f4ca6 100644 --- a/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java +++ b/tooling/apt/src/main/java/org/apache/camel/tools/apt/EndpointAnnotationProcessor.java @@ -437,7 +437,7 @@ public class EndpointAnnotationProcessor extends AbstractAnnotationProcessor { // if (doc != null) { // model.setDescription(sanitizeDescription(doc, true)); // } else { - model.setDescription(""); + model.setDescription("TODO"); // } if (map.containsKey("groupId")) { model.setGroupId(map.get("groupId"));
