camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From davscl...@apache.org
Subject [1/3] camel git commit: Add component documentation.
Date Mon, 04 May 2015 12:59:03 GMT
Repository: camel
Updated Branches:
  refs/heads/master 2999a50c6 -> df47d5e98


Add component documentation.


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

Branch: refs/heads/master
Commit: f082aed561db28c24410e989fb535b65b7a1a31d
Parents: 2999a50
Author: Claus Ibsen <davsclaus@apache.org>
Authored: Mon May 4 14:34:59 2015 +0200
Committer: Claus Ibsen <davsclaus@apache.org>
Committed: Mon May 4 14:34:59 2015 +0200

----------------------------------------------------------------------
 .../component/geocoder/GeoCoderEndpoint.java    | 22 ++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/f082aed5/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java
----------------------------------------------------------------------
diff --git a/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java
b/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java
index 330039c..a4c07d5 100644
--- a/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java
+++ b/components/camel-geocoder/src/main/java/org/apache/camel/component/geocoder/GeoCoderEndpoint.java
@@ -30,9 +30,9 @@ import org.apache.camel.spi.UriPath;
 @UriEndpoint(scheme = "geocoder", title = "Geocoder", syntax = "geocoder:address:latlng",
producerOnly = true, label = "api,location")
 public class GeoCoderEndpoint extends DefaultEndpoint {
 
-    @UriPath(description = "The geo address which must prefix with address:")
+    @UriPath
     private String address;
-    @UriPath(description = "The geo coordinate which must prefix with latng:")
+    @UriPath
     private String latlng;
     @UriParam(defaultValue = "en")
     private String language = "en";
@@ -66,6 +66,9 @@ public class GeoCoderEndpoint extends DefaultEndpoint {
         return language;
     }
 
+    /**
+     * The language to use.
+     */
     public void setLanguage(String language) {
         this.language = language;
     }
@@ -74,6 +77,9 @@ public class GeoCoderEndpoint extends DefaultEndpoint {
         return address;
     }
 
+    /**
+     * The geo address which should be prefixed with <tt>address:</tt>
+     */
     public void setAddress(String address) {
         this.address = address;
     }
@@ -82,6 +88,9 @@ public class GeoCoderEndpoint extends DefaultEndpoint {
         return latlng;
     }
 
+    /**
+     * The geo latitude and longitude which should be prefixed with <tt>latlng:</tt>
+     */
     public void setLatlng(String latlng) {
         this.latlng = latlng;
     }
@@ -90,6 +99,9 @@ public class GeoCoderEndpoint extends DefaultEndpoint {
         return headersOnly;
     }
 
+    /**
+     * Whether to only enrich the Exchange with headers, and leave the body as-is.
+     */
     public void setHeadersOnly(boolean headersOnly) {
         this.headersOnly = headersOnly;
     }
@@ -98,6 +110,9 @@ public class GeoCoderEndpoint extends DefaultEndpoint {
         return clientId;
     }
 
+    /**
+     * To use google premium with this client id
+     */
     public void setClientId(String clientId) {
         this.clientId = clientId;
     }
@@ -106,6 +121,9 @@ public class GeoCoderEndpoint extends DefaultEndpoint {
         return clientKey;
     }
 
+    /**
+     * To use google premium with this client key
+     */
     public void setClientKey(String clientKey) {
         this.clientKey = clientKey;
     }


Mime
View raw message