Improved the endpoint and the general documentation.
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/18f5be65 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/18f5be65 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/18f5be65 Branch: refs/heads/master Commit: 18f5be656d05b0ab95e2fb66f3f3aade6d6d5fff Parents: 0f9b3c9 Author: gilfernandes <gil.fernan...@gmail.com> Authored: Thu Nov 24 21:02:38 2016 +0000 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Fri Nov 25 10:05:37 2016 +0100 ---------------------------------------------------------------------- components/camel-firebase/src/main/docs/firebase-component.adoc | 4 ++-- .../org/apache/camel/component/firebase/FirebaseEndpoint.java | 5 ++++- 2 files changed, 6 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/18f5be65/components/camel-firebase/src/main/docs/firebase-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-firebase/src/main/docs/firebase-component.adoc b/components/camel-firebase/src/main/docs/firebase-component.adoc index 4d6837a..29c912b 100644 --- a/components/camel-firebase/src/main/docs/firebase-component.adoc +++ b/components/camel-firebase/src/main/docs/firebase-component.adoc @@ -4,8 +4,8 @@ Firebase Component *Available as of Camel 2.19* -The *firebase* component enables you to save, modify data in Google Firebase database -and consume to all child of a specific reference. +The *Firebase* component enables you to save, modify data in Google Firebase database. +Furthermore it allows you to consume and process all child events mapped to a specific Firebase reference. This component supports producer and event based consumer endpoints. http://git-wip-us.apache.org/repos/asf/camel/blob/18f5be65/components/camel-firebase/src/main/java/org/apache/camel/component/firebase/FirebaseEndpoint.java ---------------------------------------------------------------------- diff --git a/components/camel-firebase/src/main/java/org/apache/camel/component/firebase/FirebaseEndpoint.java b/components/camel-firebase/src/main/java/org/apache/camel/component/firebase/FirebaseEndpoint.java index 41d7a61..38e254d 100644 --- a/components/camel-firebase/src/main/java/org/apache/camel/component/firebase/FirebaseEndpoint.java +++ b/components/camel-firebase/src/main/java/org/apache/camel/component/firebase/FirebaseEndpoint.java @@ -27,7 +27,10 @@ import org.apache.camel.spi.UriParam; import org.apache.camel.spi.UriPath; /** - * Represents a Firebase endpoint. + * The Google Firebase component enables you to save and modify data in a Google Firebase database + * via the {@link FirebaseProducer} class. + * Furthermore it allows you to consume and process all child events mapped to a specific Firebase reference + * via the {@link FirebaseConsumer} class. */ @UriEndpoint(scheme = "firebase", title = "Firebase", syntax = "firebase:databaseUrl", consumerClass = FirebaseConsumer.class, label = "cloud,messaging") public class FirebaseEndpoint extends DefaultEndpoint {
