diff --git a/CHANGES.txt b/CHANGES.txt
index 1788f86fb9a..19683edb6b1 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -4,3 +4,4 @@ HBase Change Log
Trunk (unreleased changes)
1. HADOOP-1384. HBase omnibus patch. (jimk, Vuk Ercegovac, and Michael Stack)
+ 2. HADOOP-1402. Fix javadoc warnings in hbase contrib. (Michael Stack)
diff --git a/src/java/org/apache/hadoop/hbase/HLog.java b/src/java/org/apache/hadoop/hbase/HLog.java
index 3023406445e..07de6916920 100644
--- a/src/java/org/apache/hadoop/hbase/HLog.java
+++ b/src/java/org/apache/hadoop/hbase/HLog.java
@@ -357,7 +357,7 @@ public class HLog implements HConstants {
* and complete of a cache-flush. Otherwise the log-seq-id for
* the flush will not appear in the correct logfile.
* @return sequence ID to pass {@link #completeCacheFlush(Text, Text, long)}
- * @see {@link #completeCacheFlush(Text, Text, long)}
+ * @see #completeCacheFlush(Text, Text, long)
*/
public synchronized long startCacheFlush() {
while (insideCacheFlush) {
@@ -428,4 +428,4 @@ public class HLog implements HConstants {
log.close();
}
}
-}
\ No newline at end of file
+}
diff --git a/src/java/org/apache/hadoop/hbase/HRegionInterface.java b/src/java/org/apache/hadoop/hbase/HRegionInterface.java
index 796fa336ab3..3aeade280d1 100644
--- a/src/java/org/apache/hadoop/hbase/HRegionInterface.java
+++ b/src/java/org/apache/hadoop/hbase/HRegionInterface.java
@@ -64,7 +64,6 @@ public interface HRegionInterface extends VersionedProtocol {
/**
* Opens a remote scanner.
*
- * @param clientId - client identifier (so we can associate a scanner with a client)
* @param regionName - name of region to scan
* @param columns - columns to scan
* @param startRow - starting row to scan
@@ -79,8 +78,6 @@ public interface HRegionInterface extends VersionedProtocol {
*
* @param scannerId - clientId passed to openScanner
* @param key - the next HStoreKey
- * @param columns - an array of column names
- * @param values - an array of byte[] values (corresponds 1-1 with columns)
* @return - true if a value was retrieved
* @throws IOException
*/
diff --git a/src/java/org/apache/hadoop/hbase/HStoreKey.java b/src/java/org/apache/hadoop/hbase/HStoreKey.java
index 87b610e48a9..27f24f465f4 100644
--- a/src/java/org/apache/hadoop/hbase/HStoreKey.java
+++ b/src/java/org/apache/hadoop/hbase/HStoreKey.java
@@ -93,8 +93,8 @@ public class HStoreKey implements WritableComparable {
/**
* @param other Key to compare against. Compares row and column.
* @return True if same row and column.
- * @see {@link #matchesWithoutColumn(HStoreKey)}
- * @see {@link #matchesRowFamily(HStoreKey)}
+ * @see #matchesWithoutColumn(HStoreKey)
+ * @see #matchesRowFamily(HStoreKey)
*/
public boolean matchesRowCol(HStoreKey other) {
return this.row.compareTo(other.row) == 0
@@ -105,8 +105,8 @@ public class HStoreKey implements WritableComparable {
* @param other Key to copmare against. Compares row and timestamp.
*
* @return True if same row and timestamp is greater than other
- * @see {@link #matchesRowCol(HStoreKey)}
- * @see {@link #matchesRowFamily(HStoreKey)}
+ * @see #matchesRowCol(HStoreKey)
+ * @see #matchesRowFamily(HStoreKey)
*/
public boolean matchesWithoutColumn(HStoreKey other) {
return this.row.compareTo(other.row) == 0
@@ -117,8 +117,8 @@ public class HStoreKey implements WritableComparable {
* @param other Key to compare against. Compares row and column family
*
* @return true if same row and column family
- * @see {@link #matchesRowCol(HStoreKey)}
- * @see {@link #matchesWithoutColumn(HStoreKey)}
+ * @see #matchesRowCol(HStoreKey)
+ * @see #matchesWithoutColumn(HStoreKey)
*/
public boolean matchesRowFamily(HStoreKey other) {
boolean status = false;
diff --git a/src/java/org/apache/hadoop/hbase/package.html b/src/java/org/apache/hadoop/hbase/package.html
index 9866f5d6030..889d61d6156 100644
--- a/src/java/org/apache/hadoop/hbase/package.html
+++ b/src/java/org/apache/hadoop/hbase/package.html
@@ -2,21 +2,38 @@
JAVA_HOME
to the root of your Java installationFirst, you need a working instance of Hadoop. Download releases at Hadoop downloads. -Unpack the release and connect to its top-level directory. Edit the file conf/hadoop-env.sh to define at least JAVA_HOME. Try the following command: +
First, you need a working instance of Hadoop. Download a recent release from
+Hadoop downloads.
+Unpack the release and connect to its top-level directory. Edit the file
+conf/hadoop-env.sh
to define at least JAVA_HOME
. Also,
+add site-particular customizations to the file conf/hadoop-site.xml
.
+Try the following command:
bin/hadoopThis will display the documentation for the Hadoop command script. -
TODO
+Next, start hbase servers. Currently each server -- the master server and the +'slave' regionservers -- must be started manually (FIX). +
src/contrib/hbase/bin/hbase master start +src/contrib/hbase/bin/hbase regionserver start ++ +
As for hadoop, local customizations can be added to
+src/contrib/hbase/conf/hbase-site.xml
.
+