Issue-211: Fix javadoc warnings from tap and vbucket class.

Change-Id: I209a474cbd3fb153c0c95701e5943aaa2560b5cd Reviewed-on: http://review.couchbase.org/10328 Tested-by: Michael Wiederhold <mike@couchbase.com> Reviewed-by: Michael Wiederhold <mike@couchbase.com>
dustin · Oct 27, 2011 · 2b913f7 · 2b913f7
1 parent 7cb63b8
commit 2b913f7
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 10 deletions.
diff --git a/src/main/java/net/spy/memcached/internal/BulkFuture.java b/src/main/java/net/spy/memcached/internal/BulkFuture.java
@@ -37,9 +37,9 @@ public interface BulkFuture<V> extends Future<V> {
      * behavior is identical to {@link #get(long, TimeUnit)}
      *
      *
-     * @param timeout
-     * @param unit
-     * @return
+     * @param timeout time to wait for the operation to complete.
+     * @param unit specifies the unit of time for the timeout.
+     * @return returns the result or partial result of the operation.
      * @throws InterruptedException
      * @throws ExecutionException
      */

diff --git a/src/main/java/net/spy/memcached/tapmessage/BaseMessage.java b/src/main/java/net/spy/memcached/tapmessage/BaseMessage.java
@@ -88,7 +88,7 @@ public final short getKeylength() {
 
 	/**
 	 * Sets the value of the tap messages data type field.
-	 * @param b The new value for the data type field.
+	 * @param d The new value for the data type field.
 	 */
 	public final void setDatatype(byte d) {
 		datatype = d;
@@ -104,7 +104,7 @@ public final byte getDatatype() {
 
 	/**
 	 * Sets the value of the tap messages extra length field.
-	 * @param i The new value for the extra length field.
+	 * @param e The new value for the extra length field.
 	 */
 	public final void setExtralength(byte e) {
 		extralength = e;
@@ -136,7 +136,7 @@ public final short getVbucket() {
 
 	/**
 	 * Sets the value of the tap messages total body field.
-	 * @param l The new value for the total body field.
+	 * @param t The new value for the total body field.
 	 */
 	public final void setTotalbody(int t) {
 		totalbody = t;
@@ -168,7 +168,7 @@ public final int getOpaque() {
 
 	/**
 	 * Sets the value of the tap messages cas field.
-	 * @param cas The new value for the cas field.
+	 * @param c The new value for the cas field.
 	 */
 	public final void setCas(long c) {
 		cas = c;

diff --git a/src/main/java/net/spy/memcached/tapmessage/RequestMessage.java b/src/main/java/net/spy/memcached/tapmessage/RequestMessage.java
@@ -86,7 +86,7 @@ public void setVbucketlist(short[] vbs) {
 	/**
 	 * Sets a name for this tap stream. If the tap stream fails this name can be used to try to restart
 	 * the tap stream from where it last left off.
-	 * @param s The name for the tap stream.
+	 * @param n The name for the tap stream.
 	 */
 	public void setName(String n) {
 		if (n.length() > 65535) {

diff --git a/src/main/java/net/spy/memcached/tapmessage/ResponseMessage.java b/src/main/java/net/spy/memcached/tapmessage/ResponseMessage.java
@@ -34,7 +34,7 @@ public class ResponseMessage extends BaseMessage{
 
 	/**
 	 * Creates a ResponseMessage from binary data.
-	 * @param buffer The binary data sent from the tap stream server.
+	 * @param b The binary data sent from the tap stream server.
 	 */
 	public ResponseMessage(byte[] b) {
 		// TODO: This isn't the best way of doing this. In the future

diff --git a/src/main/java/net/spy/memcached/vbucket/ConfigurationProvider.java b/src/main/java/net/spy/memcached/vbucket/ConfigurationProvider.java
@@ -35,7 +35,7 @@ public interface ConfigurationProvider {
 
     /**
      * Retrieves a default bucket name i.e. 'default'
-     * @return
+     * @return the default bucket name.
      */
     String getAnonymousAuthBucket();
 }