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/3076ca4f Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/3076ca4f Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/3076ca4f Branch: refs/heads/master Commit: 3076ca4f40b03ddf82f8b57f602b4e04ed1b9ef4 Parents: 62a7aad Author: Claus Ibsen <[email protected]> Authored: Sun Dec 27 14:57:40 2015 +0100 Committer: Claus Ibsen <[email protected]> Committed: Sun Dec 27 18:25:27 2015 +0100 ---------------------------------------------------------------------- .../main/java/org/apache/camel/component/kafka/KafkaEndpoint.java | 3 +++ .../java/org/apache/camel/component/kestrel/KestrelEndpoint.java | 2 +- .../main/java/org/apache/camel/component/krati/KratiEndpoint.java | 2 +- .../org/apache/camel/component/kubernetes/KubernetesEndpoint.java | 3 +++ .../main/java/org/apache/camel/component/ldap/LdapEndpoint.java | 2 +- .../org/apache/camel/component/linkedin/LinkedInEndpoint.java | 2 +- .../java/org/apache/camel/component/lucene/LuceneEndpoint.java | 3 +++ 7 files changed, 13 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java b/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java index 3073385..760ec19a 100644 --- a/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java +++ b/components/camel-kafka/src/main/java/org/apache/camel/component/kafka/KafkaEndpoint.java @@ -30,6 +30,9 @@ import org.apache.camel.impl.DefaultEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; +/** + * The kafka component allows messages to be sent to (or consumed from) Apache Kafka brokers. + */ @UriEndpoint(scheme = "kafka", title = "Kafka", syntax = "kafka:brokers", consumerClass = KafkaConsumer.class, label = "messaging") public class KafkaEndpoint extends DefaultEndpoint implements MultipleConsumersSupport { http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java b/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java index ad245c1..bdef44c 100644 --- a/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java +++ b/components/camel-kestrel/src/main/java/org/apache/camel/component/kestrel/KestrelEndpoint.java @@ -27,7 +27,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Camel endpoint for communication with a kestrel based queue. + * The kestrel component allows messages to be sent to (or consumed from) Kestrel brokers. */ @UriEndpoint(scheme = "kestrel", title = "Kestrel", syntax = "kestrel:addresses/queue", consumerClass = KestrelConsumer.class, label = "messaging") public class KestrelEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java b/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java index 16a38be..c96cac3 100644 --- a/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java +++ b/components/camel-krati/src/main/java/org/apache/camel/component/krati/KratiEndpoint.java @@ -38,7 +38,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents a Krati endpoint. + * The krati allows the use krati datastores and datasets inside Camel. */ @UriEndpoint(scheme = "krati", title = "Krati", syntax = "krati:path", consumerClass = KratiConsumer.class, label = "database,nosql") public class KratiEndpoint extends ScheduledPollEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java b/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java index 188640f..0f95f71 100644 --- a/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java +++ b/components/camel-kubernetes/src/main/java/org/apache/camel/component/kubernetes/KubernetesEndpoint.java @@ -47,6 +47,9 @@ import org.apache.camel.util.ObjectHelper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +/** + * The kubernetes component allows to work with Kubernetes PaaS. + */ @UriEndpoint(scheme = "kubernetes", title = "Kubernetes", syntax = "kubernetes:master", label = "container,cloud,paas") public class KubernetesEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java b/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java index f8ed247..d5d209d 100644 --- a/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java +++ b/components/camel-ldap/src/main/java/org/apache/camel/component/ldap/LdapEndpoint.java @@ -30,7 +30,7 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents an endpoint that synchronously invokes an LDAP server when a producer sends a message to it. + * The ldap component allows you to perform searches in LDAP servers using filters as the message payload. */ @UriEndpoint(scheme = "ldap", title = "LDAP", syntax = "ldap:dirContextName", producerOnly = true, label = "ldap") public class LdapEndpoint extends DefaultEndpoint { http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java b/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java index 4200a06..0873b11 100644 --- a/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java +++ b/components/camel-linkedin/camel-linkedin-component/src/main/java/org/apache/camel/component/linkedin/LinkedInEndpoint.java @@ -44,7 +44,7 @@ import org.apache.cxf.jaxrs.client.JAXRSClientFactory; import org.apache.cxf.jaxrs.client.WebClient; /** - * Represents a LinkedIn endpoint. + * The linkedin component is uses for retrieving LinkedIn user profiles, connections, companies, groups, posts, etc. */ @UriEndpoint(scheme = "linkedin", title = "Linkedin", syntax = "linkedin:apiName/methodName", label = "api,cloud,social", consumerClass = LinkedInConsumer.class) public class LinkedInEndpoint extends AbstractApiEndpoint<LinkedInApiName, LinkedInConfiguration> { http://git-wip-us.apache.org/repos/asf/camel/blob/3076ca4f/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java b/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java index 01fd455..2ae943b 100644 --- a/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java +++ b/components/camel-lucene/src/main/java/org/apache/camel/component/lucene/LuceneEndpoint.java @@ -25,6 +25,9 @@ import org.apache.camel.impl.DefaultEndpoint; import org.apache.camel.spi.UriEndpoint; import org.apache.camel.spi.UriParam; +/** + * To insert or query from Apache Lucene databases. + */ @UriEndpoint(scheme = "lucene", title = "Lucene", syntax = "lucene:host:operation", producerOnly = true, label = "database,search") public class LuceneEndpoint extends DefaultEndpoint { @UriParam
