[2/2] camel git commit: Component doc

2015-04-24 Thread davsclaus
Component doc


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

Branch: refs/heads/master
Commit: 774860517bf4c51a98b38fa33b6bef0b5aaffefe
Parents: e66df5f
Author: Claus Ibsen davscl...@apache.org
Authored: Fri Apr 24 15:14:38 2015 +0200
Committer: Claus Ibsen davscl...@apache.org
Committed: Fri Apr 24 15:14:38 2015 +0200

--
 .../camel/component/paho/PahoEndpoint.java  | 21 
 .../stringtemplate/StringTemplateEndpoint.java  | 10 --
 2 files changed, 29 insertions(+), 2 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/camel/blob/77486051/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java
--
diff --git 
a/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java
 
b/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java
index 7f24703..5ca943a 100644
--- 
a/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java
+++ 
b/components/camel-paho/src/main/java/org/apache/camel/component/paho/PahoEndpoint.java
@@ -143,6 +143,9 @@ public class PahoEndpoint extends DefaultEndpoint {
 return clientId;
 }
 
+/**
+ * MQTT client identifier.
+ */
 public void setClientId(String clientId) {
 this.clientId = clientId;
 }
@@ -151,6 +154,9 @@ public class PahoEndpoint extends DefaultEndpoint {
 return brokerUrl;
 }
 
+/**
+ * The URL of the MQTT broker.
+ */
 public void setBrokerUrl(String brokerUrl) {
 this.brokerUrl = brokerUrl;
 }
@@ -159,6 +165,9 @@ public class PahoEndpoint extends DefaultEndpoint {
 return topic;
 }
 
+/**
+ * Name of the topic
+ */
 public void setTopic(String topic) {
 this.topic = topic;
 }
@@ -167,6 +176,9 @@ public class PahoEndpoint extends DefaultEndpoint {
 return qos;
 }
 
+/**
+ * Client quality of service level (0-2).
+ */
 public void setQos(int qos) {
 this.qos = qos;
 }
@@ -177,6 +189,9 @@ public class PahoEndpoint extends DefaultEndpoint {
 return persistence;
 }
 
+/**
+ * Client persistence to be used - memory or file.
+ */
 public void setPersistence(PahoPersistence persistence) {
 this.persistence = persistence;
 }
@@ -185,6 +200,9 @@ public class PahoEndpoint extends DefaultEndpoint {
 return client;
 }
 
+/**
+ * To use the existing MqttClient instance as client.
+ */
 public void setClient(MqttClient client) {
 this.client = client;
 }
@@ -193,6 +211,9 @@ public class PahoEndpoint extends DefaultEndpoint {
 return connectOptions;
 }
 
+/**
+ * Client connection options
+ */
 public void setConnectOptions(MqttConnectOptions connOpts) {
 this.connectOptions = connOpts;
 }

http://git-wip-us.apache.org/repos/asf/camel/blob/77486051/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java
--
diff --git 
a/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java
 
b/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java
index 96037be..ca2978a 100644
--- 
a/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java
+++ 
b/components/camel-stringtemplate/src/main/java/org/apache/camel/component/stringtemplate/StringTemplateEndpoint.java
@@ -37,9 +37,9 @@ import org.stringtemplate.v4.STGroup;
 @UriEndpoint(scheme = stringtemplate, title = String Template, syntax = 
stringtemplate:resourceUri, producerOnly = true, label = transformation)
 public class StringTemplateEndpoint extends ResourceEndpoint {
 
-@UriParam
+@UriParam(defaultValue = )
 private char delimiterStart = STGroup.defaultGroup.delimiterStartChar;
-@UriParam
+@UriParam(defaultValue = )
 private char delimiterStop = STGroup.defaultGroup.delimiterStopChar;
 
 public StringTemplateEndpoint() {
@@ -63,6 +63,9 @@ public class StringTemplateEndpoint extends ResourceEndpoint {
 return delimiterStart;
 }
 
+/**
+ * The variable start delimiter
+ */
 public void setDelimiterStart(char delimiterStart) {
 this.delimiterStart = delimiterStart;
 }
@@ -71,6 +74,9 @@ public class StringTemplateEndpoint extends ResourceEndpoint {

[2/2] camel git commit: Component doc

2015-04-24 Thread davsclaus
Component doc


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

Branch: refs/heads/master
Commit: 196c1f5ea8c14cc5a36c7f4aed3dacaeb577e733
Parents: df79b59
Author: Claus Ibsen davscl...@apache.org
Authored: Fri Apr 24 08:03:09 2015 +0200
Committer: Claus Ibsen davscl...@apache.org
Committed: Fri Apr 24 08:03:09 2015 +0200

--
 .../camel/component/yammer/YammerComponent.java | 12 
 .../component/yammer/YammerConfiguration.java   | 61 +---
 2 files changed, 64 insertions(+), 9 deletions(-)
--


http://git-wip-us.apache.org/repos/asf/camel/blob/196c1f5e/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java
--
diff --git 
a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java
 
b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java
index 2655beb..6d83570 100644
--- 
a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java
+++ 
b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerComponent.java
@@ -57,6 +57,9 @@ public class YammerComponent extends DefaultComponent {
 return consumerKey;
 }
 
+/**
+ * The consumer key
+ */
 public void setConsumerKey(String consumerKey) {
 this.consumerKey = consumerKey;
 }
@@ -65,6 +68,9 @@ public class YammerComponent extends DefaultComponent {
 return consumerSecret;
 }
 
+/**
+ * The consumer secret
+ */
 public void setConsumerSecret(String consumerSecret) {
 this.consumerSecret = consumerSecret;
 }
@@ -73,6 +79,9 @@ public class YammerComponent extends DefaultComponent {
 return accessToken;
 }
 
+/**
+ * The access token
+ */
 public void setAccessToken(String accessToken) {
 this.accessToken = accessToken;
 }
@@ -81,6 +90,9 @@ public class YammerComponent extends DefaultComponent {
 return config;
 }
 
+/**
+ * To use a shared yammer configuration
+ */
 public void setConfig(YammerConfiguration config) {
 this.config = config;
 }

http://git-wip-us.apache.org/repos/asf/camel/blob/196c1f5e/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java
--
diff --git 
a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java
 
b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java
index deee282..9899d05 100644
--- 
a/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java
+++ 
b/components/camel-yammer/src/main/java/org/apache/camel/component/yammer/YammerConfiguration.java
@@ -27,25 +27,25 @@ public class YammerConfiguration {
 @UriPath(name = function) @Metadata(required = true)
 private YammerFunctionType functionType;
 private String function;
-@UriParam
+@UriParam  @Metadata(required = true)
 private String consumerKey;
-@UriParam
+@UriParam  @Metadata(required = true)
 private String consumerSecret;
-@UriParam
+@UriParam  @Metadata(required = true)
 private String accessToken;
 @UriParam
 private boolean useJson;
-@UriParam(defaultValue = 5000)
+@UriParam(label = consumer, defaultValue = 5000)
 private long delay = 3000 + 2000; // 3 sec per poll is enforced by yammer; 
add 2 sec for safety
-@UriParam(defaultValue = -1)
+@UriParam(label = consumer, defaultValue = -1)
 private int limit = -1; // default is unlimited
-@UriParam(defaultValue = -1)
+@UriParam(label = consumer, defaultValue = -1)
 private int olderThan = -1;
-@UriParam(defaultValue = -1)
+@UriParam(label = consumer, defaultValue = -1)
 private int newerThan = -1;
-@UriParam
+@UriParam(label = consumer, enums = true,extended)
 private String threaded;
-@UriParam
+@UriParam(label = consumer)
 private String userId;
 private ApiRequestor requestor;
 
@@ -53,6 +53,9 @@ public class YammerConfiguration {
 return consumerKey;
 }
 
+/**
+ * The consumer key
+ */
 public void setConsumerKey(String consumerKey) {
 this.consumerKey = consumerKey;
 }
@@ -61,6 +64,9 @@ public class YammerConfiguration {
 return consumerSecret;
 }
 
+/**
+ * The consumer secret
+ */
 public void setConsumerSecret(String consumerSecret) {