Documentation for geo commands #86

More javadocs for the API
redis · Jun 23, 2015 · bd66695 · bd66695
1 parent 9b63872
commit bd66695
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 13 deletions.
diff --git a/src/main/java/com/lambdaworks/redis/GeoArgs.java b/src/main/java/com/lambdaworks/redis/GeoArgs.java
@@ -3,6 +3,8 @@
 import com.lambdaworks.redis.protocol.CommandArgs;
 
 /**
+ * Args for {@literal GEORADIUS} and {@literal GEORADIUSBYMEMBER} commands.
+ * 
  * @author <a href="mailto:mpaluch@paluch.biz">Mark Paluch</a>
  */
 public class GeoArgs {
@@ -33,23 +35,45 @@ public GeoArgs noProperties() {
         return this;
     }
 
+    /**
+     * Sort results ascending.
+     * 
+     * @return the current geo args.
+     */
     public GeoArgs asc() {
         return sort(Sort.asc);
     }
 
+    /**
+     * Sort results descending.
+     * 
+     * @return the current geo args.
+     */
     public GeoArgs desc() {
         return sort(Sort.desc);
     }
 
+    /**
+     * Sort results.
+     * 
+     * @param sort
+     * @return the current geo args.
+     */
     public GeoArgs sort(Sort sort) {
         this.sort = sort;
         return this;
     }
 
+    /**
+     * Sort order.
+     */
     public enum Sort {
         asc, desc, none;
     }
 
+    /**
+     * Supported geo unit.
+     */
     public enum Unit {
         meter, kilometer, feet, mile;
     }

diff --git a/src/main/java/com/lambdaworks/redis/RedisGeoAsyncConnection.java b/src/main/java/com/lambdaworks/redis/RedisGeoAsyncConnection.java
@@ -18,7 +18,7 @@ public interface RedisGeoAsyncConnection<K, V> {
      * @param latitude
      * @param longitude
      * @param member
-     * @return 1 if member is new or 0 if member is updated
+     * @return Long integer-reply the number of elements that were added to the set
      */
     RedisFuture<Long> geoadd(K key, double latitude, double longitude, V member);
 
@@ -27,7 +27,7 @@ public interface RedisGeoAsyncConnection<K, V> {
      * 
      * @param key
      * @param latLonMember triplets of double latitude, double longitude and V member
-     * @return count of members submitted
+     * @return Long integer-reply the number of elements that were added to the set
      */
     RedisFuture<Long> geoadd(K key, Object... latLonMember);
 
@@ -39,7 +39,7 @@ public interface RedisGeoAsyncConnection<K, V> {
      * @param longitude
      * @param distance
      * @param unit
-     * @return
+     * @return bulk reply
      */
     RedisFuture<Set<V>> georadius(K key, double latitude, double longitude, double distance, GeoArgs.Unit unit);
 
@@ -51,7 +51,7 @@ public interface RedisGeoAsyncConnection<K, V> {
      * @param longitude
      * @param distance
      * @param unit
-     * @return
+     * @return nested multi-bulk reply
      */
     RedisFuture<List<Object>> georadius(K key, double latitude, double longitude, double distance, GeoArgs.Unit unit,
             GeoArgs geoArgs);
@@ -63,7 +63,7 @@ RedisFuture<List<Object>> georadius(K key, double latitude, double longitude, do
      * @param member
      * @param distance
      * @param unit
-     * @return
+     * @return bulk reply
      */
     RedisFuture<Set<V>> georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit);
 
@@ -75,7 +75,7 @@ RedisFuture<List<Object>> georadius(K key, double latitude, double longitude, do
      * @param member
      * @param distance
      * @param unit
-     * @return
+     * @return nested multi-bulk reply
      */
     RedisFuture<List<Object>> georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit, GeoArgs geoArgs);
 

diff --git a/src/main/java/com/lambdaworks/redis/RedisGeoConnection.java b/src/main/java/com/lambdaworks/redis/RedisGeoConnection.java
@@ -18,16 +18,16 @@ public interface RedisGeoConnection<K, V> {
      * @param latitude
      * @param longitude
      * @param member
-     * @return
+     * @return Long integer-reply the number of elements that were added to the set
      */
     Long geoadd(K key, double latitude, double longitude, V member);
 
     /**
-     * Multi geo add
+     * Multi geo add.
      * 
      * @param key
      * @param latLonMember triplets of double latitude, double longitude and V member
-     * @return
+     * @return Long integer-reply the number of elements that were added to the set
      */
     Long geoadd(K key, Object... latLonMember);
 
@@ -39,7 +39,7 @@ public interface RedisGeoConnection<K, V> {
      * @param longitude
      * @param distance
      * @param unit
-     * @return
+     * @return bulk reply
      */
     Set<V> georadius(K key, double latitude, double longitude, double distance, GeoArgs.Unit unit);
 
@@ -51,7 +51,7 @@ public interface RedisGeoConnection<K, V> {
      * @param longitude
      * @param distance
      * @param unit
-     * @return
+     * @return nested multi-bulk reply
      */
     List<Object> georadius(K key, double latitude, double longitude, double distance, GeoArgs.Unit unit, GeoArgs geoArgs);
 
@@ -62,7 +62,7 @@ public interface RedisGeoConnection<K, V> {
      * @param member
      * @param distance
      * @param unit
-     * @return
+     * @return bulk reply
      */
     Set<V> georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit);
 
@@ -74,7 +74,7 @@ public interface RedisGeoConnection<K, V> {
      * @param member
      * @param distance
      * @param unit
-     * @return
+     * @return nested multi-bulk reply
      */
     List<Object> georadiusbymember(K key, V member, double distance, GeoArgs.Unit unit, GeoArgs geoArgs);