svn commit: r712055 - in /hadoop/hbase/trunk: CHANGES.txt src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java src/java/org/apache/hadoop/hbase/util/InfoServer.java

[ji...@apache.org]

Author: jimk
Date: Thu Nov  6 20:44:36 2008
New Revision: 712055

URL: http://svn.apache.org/viewvc?rev=712055&view=rev
Log:
HBASE-984   Fix javadoc warnings
This is probably the first of several patches to fix javadoc warnings. Jira issue will remain open until we create the release candidate.

Modified:
    hadoop/hbase/trunk/CHANGES.txt
    hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java
    hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/InfoServer.java

Modified: hadoop/hbase/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/CHANGES.txt?rev=712055&r1=712054&r2=712055&view=diff
==============================================================================
--- hadoop/hbase/trunk/CHANGES.txt (original)
+++ hadoop/hbase/trunk/CHANGES.txt Thu Nov  6 20:44:36 2008
@@ -63,6 +63,7 @@
    HBASE-964   Startup stuck "waiting for root region"
    HBASE-980   Undo core of HBASE-975, caching of start and end row
    HBASE-982   Deleting a column in MapReduce fails (Doğacan Güney via Stack)
+   HBASE-984   Fix javadoc warnings
    
   IMPROVEMENTS
    HBASE-901   Add a limit to key length, check key and value length on client side

Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java?rev=712055&r1=712054&r2=712055&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/io/HalfMapFileReader.java Thu Nov  6 20:44:36 2008
@@ -27,17 +27,16 @@
 import org.apache.hadoop.hbase.HStoreKey;
 import org.apache.hadoop.hbase.io.Reference.Range;
 import org.apache.hadoop.hbase.util.Writables;
-import org.apache.hadoop.io.MapFile;
 import org.apache.hadoop.io.Writable;
 import org.apache.hadoop.io.WritableComparable;
 
 /**
- * A facade for a {@link MapFile.Reader} that serves up either the top or
- * bottom half of a MapFile where 'bottom' is the first half of the file
- * containing the keys that sort lowest and 'top' is the second half of the
- * file with keys that sort greater than those of the bottom half.  The top
- * includes the split files midkey, of the key that follows if it does not
- * exist in the file.
+ * A facade for a {@link org.apache.hadoop.io.MapFile.Reader} that serves up
+ * either the top or bottom half of a MapFile where 'bottom' is the first half
+ * of the file containing the keys that sort lowest and 'top' is the second half
+ * of the file with keys that sort greater than those of the bottom half.
+ * The top includes the split files midkey, of the key that follows if it does
+ * not exist in the file.
  * 
  * <p>This type works in tandem with the {@link Reference} type.  This class
  * is used reading while Reference is used writing.
@@ -49,6 +48,15 @@
   private final HStoreKey midkey;
   private boolean firstNextCall = true;
   
+  /**
+   * @param fs
+   * @param dirName
+   * @param conf
+   * @param r
+   * @param mk
+   * @param hri
+   * @throws IOException
+   */
   public HalfMapFileReader(final FileSystem fs, final String dirName, 
       final Configuration conf, final Range r,
       final WritableComparable<HStoreKey> mk,
@@ -57,6 +65,17 @@
     this(fs, dirName, conf, r, mk, false, false, hri);
   }
   
+  /**
+   * @param fs
+   * @param dirName
+   * @param conf
+   * @param r
+   * @param mk
+   * @param filter
+   * @param blockCacheEnabled
+   * @param hri
+   * @throws IOException
+   */
   @SuppressWarnings("unchecked")
   public HalfMapFileReader(final FileSystem fs, final String dirName, 
       final Configuration conf, final Range r,
@@ -94,6 +113,7 @@
     }
   }
 
+  @SuppressWarnings("unchecked")
   @Override
   public synchronized void finalKey(WritableComparable key)
   throws IOException {

Modified: hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/InfoServer.java
URL: http://svn.apache.org/viewvc/hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/InfoServer.java?rev=712055&r1=712054&r2=712055&view=diff
==============================================================================
--- hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/InfoServer.java (original)
+++ hadoop/hbase/trunk/src/java/org/apache/hadoop/hbase/util/InfoServer.java Thu Nov  6 20:44:36 2008
@@ -39,9 +39,11 @@
    * Create a status server on the given port.
    * The jsp scripts are taken from src/webapps/<code>name<code>.
    * @param name The name of the server
+   * @param bindAddress
    * @param port The port to use on the server
    * @param findPort whether the server should start at the given port and 
    * increment by 1 until it finds a free port.
+   * @throws IOException
    */
   public InfoServer(String name, String bindAddress, int port, boolean findPort)
   throws IOException {
@@ -64,10 +66,10 @@
   }
   
   /**
-  * Get the pathname to the <code>path</code> files.
-  * @param path Path to find.
-  * @return the pathname as a URL
-  */
+   * Get the pathname to the <code>path</code> files.
+   * @return the pathname as a URL
+   */
+  @Override
   protected String getWebAppsPath() throws IOException {
     // Hack: webapps is not a unique enough element to find in CLASSPATH
     // We'll more than likely find the hadoop webapps dir.  So, instead