You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2017/03/08 09:17:23 UTC

camel git commit: Component docs

Repository: camel
Updated Branches:
  refs/heads/master 6407919bb -> 8c43ee7e1


Component docs


Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/8c43ee7e
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/8c43ee7e
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/8c43ee7e

Branch: refs/heads/master
Commit: 8c43ee7e1fc883e5f65499a23cb0181ca228f674
Parents: 6407919
Author: Claus Ibsen <da...@apache.org>
Authored: Wed Mar 8 10:17:16 2017 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Wed Mar 8 10:17:16 2017 +0100

----------------------------------------------------------------------
 .../main/docs/chronicle-engine-component.adoc   | 15 +++++++-
 .../engine/ChronicleEngineEndpoint.java         |  2 +-
 .../src/main/docs/etcd-component.adoc           | 39 ++++++--------------
 .../src/main/docs/jcache-component.adoc         |  8 +++-
 4 files changed, 34 insertions(+), 30 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/8c43ee7e/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
index b7d4631..d954a90 100644
--- a/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
+++ b/components/camel-chronicle/src/main/docs/chronicle-engine-component.adoc
@@ -2,6 +2,19 @@
 
 *Available as of Camel version 2.18*
 
+The camel chronicle-engine component let you leverage the power of OpenHFT's Chronicle-Engine
+
+### URI Format
+
+[source,java]
+----------------------------
+chronicle-engine:addresses/path[?options]
+----------------------------
+
+
+### URI Options
+
+
 // component options: START
 The Chronicle Engine component has no options.
 // component options: END
@@ -20,7 +33,7 @@ The Chronicle Engine endpoint is configured using URI syntax:
 [width="100%",cols="2,1,1m,6",options="header"]
 |=======================================================================
 | Name | Default | Java Type | Description
-| addresses |  | String | *Required* Engine addresses. Multiple addresses can be separated by comman.
+| addresses |  | String | *Required* Engine addresses. Multiple addresses can be separated by comma.
 | path |  | String | *Required* Engine path
 |=======================================================================
 

http://git-wip-us.apache.org/repos/asf/camel/blob/8c43ee7e/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java b/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java
index 7735ac0..69b5a6f 100644
--- a/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java
+++ b/components/camel-chronicle/src/main/java/org/apache/camel/component/chronicle/engine/ChronicleEngineEndpoint.java
@@ -39,7 +39,7 @@ import org.apache.camel.spi.UriPath;
     label = "datagrid,cache")
 public class ChronicleEngineEndpoint extends DefaultEndpoint {
 
-    @UriPath(description = "Engine addresses. Multiple addresses can be separated by comman.")
+    @UriPath(description = "Engine addresses. Multiple addresses can be separated by comma.")
     @Metadata(required = "true")
     private String addresses;
     @UriPath(description = "Engine path")

http://git-wip-us.apache.org/repos/asf/camel/blob/8c43ee7e/components/camel-etcd/src/main/docs/etcd-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-etcd/src/main/docs/etcd-component.adoc b/components/camel-etcd/src/main/docs/etcd-component.adoc
index 7542518..9aa833a 100644
--- a/components/camel-etcd/src/main/docs/etcd-component.adoc
+++ b/components/camel-etcd/src/main/docs/etcd-component.adoc
@@ -1,19 +1,21 @@
 ## etcd Component
-+[[Etcd-Etcd]]
-*Available as of Camel version 2.18.0*
-
-+Etcd
-
-
-
-
-
 
+*Available as of Camel version 2.18*
 
+The camel etcd component allows you to work with Etcd, a distributed reliable key-value store.
 
+### URI Format
 
+[source,java]
+----------------------------
+etcd:namespace/path[?options]
+----------------------------
 
+### URI Options
 
+// component options: START
+The etcd component has no options.
+// component options: END
 
 // endpoint options: START
 The etcd endpoint is configured using URI syntax:
@@ -66,21 +68,4 @@ The etcd endpoint is configured using URI syntax:
 | sslContextParameters | security |  | SSLContextParameters | To configure security using SSLContextParameters.
 | userName | security |  | String | The user name to use for basic authentication.
 |=======================================================================
-// endpoint options: END
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-// component options: START
-The etcd component has no options.
-// component options: END
+// endpoint options: END
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/camel/blob/8c43ee7e/components/camel-jcache/src/main/docs/jcache-component.adoc
----------------------------------------------------------------------
diff --git a/components/camel-jcache/src/main/docs/jcache-component.adoc b/components/camel-jcache/src/main/docs/jcache-component.adoc
index a6ffe1c..64f4a98 100644
--- a/components/camel-jcache/src/main/docs/jcache-component.adoc
+++ b/components/camel-jcache/src/main/docs/jcache-component.adoc
@@ -2,10 +2,16 @@
 
 *Available as of Camel version 2.17*
 
+The jcache component enables you to perform caching operations using JSR107/JCache as cache implementation.
 
+### URI Format
 
+[source,java]
+----------------------------
+jcache:cacheName[?options]
+----------------------------
 
-
+### URI Options
 
 // endpoint options: START
 The JCache endpoint is configured using URI syntax: