From 2e05ca43b653f785a1753a0997be48d80ed017e3 Mon Sep 17 00:00:00 2001
From: Costin Leau <cleau@vmware.com>
Date: Tue, 7 Dec 2010 20:25:53 +0200
Subject: [PATCH] + hopefully finally finished with the javadocs

---
 .../keyvalue/redis/connection/DefaultSortParameters.java  | 6 +++---
 .../redis/connection/jedis/JedisConnectionFactory.java    | 4 ++--
 .../keyvalue/redis/connection/jedis/package-info.java     | 2 +-
 .../keyvalue/redis/connection/jredis/package-info.java    | 2 +-
 .../springframework/data/keyvalue/redis/package-info.java | 8 ++++++++
 .../keyvalue/redis/support/collections/RedisZSet.java     | 5 +++--
 .../keyvalue/redis/support/collections/package-info.java  | 7 ++++---
 7 files changed, 22 insertions(+), 12 deletions(-)
 create mode 100644 spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/package-info.java

diff --git a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/DefaultSortParameters.java b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/DefaultSortParameters.java
index b03c91fef..0098ac36e 100644
--- a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/DefaultSortParameters.java
+++ b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/DefaultSortParameters.java
@@ -56,11 +56,11 @@ public class DefaultSortParameters implements SortParameters {
 	 * @param order
 	 * @param alphabetic
 	 */
-	public DefaultSortParameters(byte[] by, Range limit, byte[] get, Order order, Boolean alphabetic) {
+	public DefaultSortParameters(byte[] byPattern, Range limit, byte[] getPattern, Order order, Boolean alphabetic) {
 		super();
-		this.byPattern = by;
+		this.byPattern = byPattern;
 		this.limit = limit;
-		this.getPattern = get;
+		this.getPattern = getPattern;
 		this.order = order;
 		this.alphabetic = alphabetic;
 	}
diff --git a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jedis/JedisConnectionFactory.java b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jedis/JedisConnectionFactory.java
index 2cb20a879..186229230 100644
--- a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jedis/JedisConnectionFactory.java
+++ b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jedis/JedisConnectionFactory.java
@@ -59,7 +59,7 @@ public class JedisConnectionFactory implements InitializingBean, DisposableBean,
 	/**
 	 * Constructs a new <code>JedisConnectionFactory</code> instance.
 	 *
-	 * @param hostname
+	 * @param hostName
 	 */
 	public JedisConnectionFactory(String hostName) {
 		Assert.hasText(hostName);
@@ -69,7 +69,7 @@ public class JedisConnectionFactory implements InitializingBean, DisposableBean,
 	/**
 	 * Constructs a new <code>JedisConnectionFactory</code> instance.
 	 *
-	 * @param hostname
+	 * @param hostName
 	 * @param port
 	 */
 	public JedisConnectionFactory(String hostName, int port) {
diff --git a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jedis/package-info.java b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jedis/package-info.java
index b1f4bfd97..40ce7c10d 100644
--- a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jedis/package-info.java
+++ b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jedis/package-info.java
@@ -1,5 +1,5 @@
 /**
- * <p/>Connection package for <a href="http://github.com/xetorthio/jedis">Jedis</a> library.
+ * Connection package for <a href="http://github.com/xetorthio/jedis">Jedis</a> library.
  */
 package org.springframework.data.keyvalue.redis.connection.jedis;
 
diff --git a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jredis/package-info.java b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jredis/package-info.java
index 50fad613e..0affe42a0 100644
--- a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jredis/package-info.java
+++ b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/connection/jredis/package-info.java
@@ -1,5 +1,5 @@
 /**
- * <p/>Connection package for <a href="http://github.com/alphazero/jredis">JRedis</a> library.
+ * Connection package for <a href="http://github.com/alphazero/jredis">JRedis</a> library.
  */
 package org.springframework.data.keyvalue.redis.connection.jredis;
 
diff --git a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/package-info.java b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/package-info.java
new file mode 100644
index 000000000..96920cf44
--- /dev/null
+++ b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * Root package for integrating <a href="http://code.google.com/p/redis/">Redis</a> with Spring concepts.
+ * <p/>
+ * Provides Redis specific exception hierarchy on top of the {@code org.springframework.dao} package. 
+ * 
+ */
+package org.springframework.data.keyvalue.redis;
+
diff --git a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/support/collections/RedisZSet.java b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/support/collections/RedisZSet.java
index 991e3b176..c0b095a84 100644
--- a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/support/collections/RedisZSet.java
+++ b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/support/collections/RedisZSet.java
@@ -22,8 +22,9 @@ import java.util.Set;
 import java.util.SortedSet;
 
 /**
- * Redis ZSet contract. Acts as a {@link SortedSet} based on the given priorities. Since using a {@link Comparator}
- * does not apply, a ZSet implements the {@link SortedSet} methods where applicable.
+ * Redis ZSet (or sorted set (by weight)). Acts as a {@link SortedSet} based on the given priorities or weights associated with each item.
+ * <p/>
+ * Since using a {@link Comparator} does not apply, a ZSet implements the {@link SortedSet} methods where applicable.
  * 
  * @author Costin Leau
  */
diff --git a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/support/collections/package-info.java b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/support/collections/package-info.java
index 2ecbed194..e00eeab04 100644
--- a/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/support/collections/package-info.java
+++ b/spring-data-redis/src/main/java/org/springframework/data/keyvalue/redis/support/collections/package-info.java
@@ -2,10 +2,11 @@
  * Package providing implementations for most of the {@code java.util} collections on top of Redis.
  * <p/>
  * For indexed collections, such as {@link java.util.List}, {@link java.util.Queue} or {@link java.util.Deque} 
- * consider {@link RedisList}.<p/>
- * For collections without duplicates the obvious candidate is {@link RedisSet}. Use {@link RedisZSet} if a 
+ * consider {@link org.springframework.data.keyvalue.redis.support.collections.RedisList}.<p/>
+ * For collections without duplicates the obvious candidate is {@link org.springframework.data.keyvalue.redis.support.collections.RedisSet}. Use 
+ * {@link org.springframework.data.keyvalue.redis.support.collections.RedisZSet} if a 
  * certain order is required.</p/>
- * Lastly, for key/value associations {@link RedisMap} providing a Map-like abstraction on top of a Redis hash.
+ * Lastly, for key/value associations {@link org.springframework.data.keyvalue.redis.support.collections.RedisMap} providing a Map-like abstraction on top of a Redis hash.
  */
 package org.springframework.data.keyvalue.redis.support.collections;