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/0d49f6bc Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0d49f6bc Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0d49f6bc Branch: refs/heads/master Commit: 0d49f6bcdc71096ea6b7682fd1679817234dcd6c Parents: 5b9595a Author: Claus Ibsen <[email protected]> Authored: Sun Dec 27 16:58:56 2015 +0100 Committer: Claus Ibsen <[email protected]> Committed: Sun Dec 27 18:25:29 2015 +0100 ---------------------------------------------------------------------- .../apache/camel/component/twitter/TwitterEndpointPolling.java | 2 +- .../org/apache/camel/component/undertow/UndertowEndpoint.java | 2 +- .../org/apache/camel/component/velocity/VelocityEndpoint.java | 3 +++ .../java/org/apache/camel/component/vertx/VertxEndpoint.java | 2 +- .../org/apache/camel/component/weather/WeatherEndpoint.java | 2 +- .../org/apache/camel/component/websocket/WebsocketEndpoint.java | 5 +++++ .../java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java | 2 +- .../camel/component/xmlsecurity/XmlSignatureEndpoint.java | 3 +++ .../main/java/org/apache/camel/component/xmpp/XmppEndpoint.java | 2 +- .../java/org/apache/camel/component/yammer/YammerEndpoint.java | 2 +- .../org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java | 2 +- 11 files changed, 19 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java ---------------------------------------------------------------------- diff --git a/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java b/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java index 2d42b93..4a77d29 100644 --- a/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java +++ b/components/camel-twitter/src/main/java/org/apache/camel/component/twitter/TwitterEndpointPolling.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * Twitter polling endpoint + * This component integrates with Twitter to send tweets or search for tweets and more. */ @ManagedResource(description = "Managed Twitter Endpoint") @UriEndpoint(scheme = "twitter", title = "Twitter", syntax = "twitter:type", consumerClass = Twitter4JConsumer.class, label = "api,social") http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java b/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java index 621c5fd..b41a205 100644 --- a/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java +++ b/components/camel-undertow/src/main/java/org/apache/camel/component/undertow/UndertowEndpoint.java @@ -44,7 +44,7 @@ import org.xnio.OptionMap; import org.xnio.Options; /** - * Represents an Undertow endpoint. + * The undertow component provides HTTP-based endpoints for consuming and producing HTTP requests */ @UriEndpoint(scheme = "undertow", title = "Undertow", syntax = "undertow:httpURI", consumerClass = UndertowConsumer.class, label = "http") http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java b/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java index c36c7d1..1429bae 100644 --- a/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java +++ b/components/camel-velocity/src/main/java/org/apache/camel/component/velocity/VelocityEndpoint.java @@ -40,6 +40,9 @@ import org.apache.velocity.context.Context; import org.apache.velocity.runtime.RuntimeConstants; import org.apache.velocity.runtime.log.CommonsLogLogChute; +/** + * Generates a response using an Apache Velocity template. + */ @UriEndpoint(scheme = "velocity", title = "Velocity", syntax = "velocity:resourceUri", producerOnly = true, label = "transformation") public class VelocityEndpoint extends ResourceEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java b/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java index 2831282..7fbdccd 100644 --- a/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java +++ b/components/camel-vertx/src/main/java/org/apache/camel/component/vertx/VertxEndpoint.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * A Camel Endpoint for working with <a href="http://vertx.io/";>vert.x</a> event bus endpoints + * The vertx component is used for sending and receive messages from a vertx event bus. */ @UriEndpoint(scheme = "vertx", title = "Vert.x", syntax = "vertx:address", consumerClass = VertxConsumer.class, label = "eventbus") public class VertxEndpoint extends DefaultEndpoint implements MultipleConsumersSupport { http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java b/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java index 987718f..acff9e6 100644 --- a/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java +++ b/components/camel-weather/src/main/java/org/apache/camel/component/weather/WeatherEndpoint.java @@ -24,7 +24,7 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * Weather Endpoint + * Polls the weather information from Open Weather Map */ @UriEndpoint(scheme = "weather", title = "Weather", syntax = "weather:name", consumerClass = WeatherConsumer.class, label = "api") public class WeatherEndpoint extends DefaultPollingEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java b/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java index 26100f9..a71eabc 100644 --- a/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java +++ b/components/camel-websocket/src/main/java/org/apache/camel/component/websocket/WebsocketEndpoint.java @@ -33,6 +33,11 @@ import org.apache.camel.util.ObjectHelper; import org.apache.camel.util.jsse.SSLContextParameters; import org.eclipse.jetty.server.Handler; +/** + * The websocket component provides websocket endpoints for communicating with clients using websocket. + * + * This component uses Jetty as the websocket implementation. + */ @UriEndpoint(scheme = "websocket", title = "Jetty Websocket", syntax = "websocket:host:port/resourceUri", consumerClass = WebsocketConsumer.class, label = "websocket") public class WebsocketEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java b/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java index 0576d0f..343bf43 100644 --- a/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java +++ b/components/camel-xmlrpc/src/main/java/org/apache/camel/component/xmlrpc/XmlRpcEndpoint.java @@ -35,7 +35,7 @@ import org.apache.xmlrpc.client.XmlRpcClient; import org.apache.xmlrpc.client.XmlRpcClientConfigImpl; /** - * Represents a xmlrpc endpoint. + * The xmlrpc component is used for sending messages to a XML RPC service. */ @UriEndpoint(scheme = "xmlrpc", title = "XML RPC", syntax = "xmlrpc:address", producerOnly = true, label = "transformation") public class XmlRpcEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java b/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java index dd93b56..c3883fe 100644 --- a/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java +++ b/components/camel-xmlsecurity/src/main/java/org/apache/camel/component/xmlsecurity/XmlSignatureEndpoint.java @@ -31,6 +31,9 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; +/** + * Used to sign and verify exchanges using the XML signature specification. + */ @UriEndpoint(scheme = "xmlsecurity", title = "XML Security", syntax = "xmlsecurity:command/name", producerOnly = true, label = "security,transformation") public abstract class XmlSignatureEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java b/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java index 041c7c1..97c022d 100644 --- a/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java +++ b/components/camel-xmpp/src/main/java/org/apache/camel/component/xmpp/XmppEndpoint.java @@ -47,7 +47,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * A XMPP Endpoint + * To send and receive messages from a XMPP (chat) server. */ @UriEndpoint(scheme = "xmpp", title = "XMPP", syntax = "xmpp:host:port/participant", consumerClass = XmppConsumer.class, label = "chat,messaging") public class XmppEndpoint extends DefaultEndpoint implements HeaderFilterStrategyAware { http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java index 5027962..d2675e5 100644 --- a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java +++ b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerEndpoint.java @@ -24,7 +24,7 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * Represents a Yammer endpoint. + * The yammer component allows you to interact with the Yammer enterprise social network. */ @UriEndpoint(scheme = "yammer", title = "Yammer", syntax = "yammer:function", consumerClass = YammerMessagePollingConsumer.class, label = "social") public class YammerEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/0d49f6bc/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java b/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java index 0cc2036..e85876d 100644 --- a/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java +++ b/components/camel-zookeeper/src/main/java/org/apache/camel/component/zookeeper/ZooKeeperEndpoint.java @@ -29,7 +29,7 @@ import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; /** - * <code>ZooKeeperEndpoint</code> + * The zookeeper component allows interaction with a ZooKeeper cluster. */ @ManagedResource(description = "ZooKeeper Endpoint") @UriEndpoint(scheme = "zookeeper", title = "ZooKeeper", syntax = "zookeeper:serverUrls/path", consumerClass = ZooKeeperConsumer.class, label = "clustering")
