From 72c3a3414625f521209c96a0d886d27241d076bc Mon Sep 17 00:00:00 2001 From: Michael Stack Date: Sat, 19 Nov 2011 22:11:17 +0000 Subject: [PATCH] HBASE-4829 Fix javadoc warnings in 0.92 branch git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1204094 13f79535-47bb-0310-9956-ffa450edef68 --- .../java/org/apache/hadoop/hbase/catalog/CatalogTracker.java | 2 +- src/main/java/org/apache/hadoop/hbase/client/Result.java | 4 ++-- src/main/java/org/apache/hadoop/hbase/ipc/RequestContext.java | 2 +- .../org/apache/hadoop/hbase/mapreduce/TableInputFormat.java | 3 +-- src/main/java/org/apache/hadoop/hbase/security/User.java | 2 +- src/main/java/org/apache/hadoop/hbase/util/FSUtils.java | 1 - .../org/apache/hadoop/hbase/zookeeper/ZKLeaderManager.java | 4 ++-- src/main/java/org/apache/hadoop/hbase/zookeeper/ZKUtil.java | 2 +- 8 files changed, 9 insertions(+), 11 deletions(-) diff --git a/src/main/java/org/apache/hadoop/hbase/catalog/CatalogTracker.java b/src/main/java/org/apache/hadoop/hbase/catalog/CatalogTracker.java index 9aa812f3260..1c49dc5e04f 100644 --- a/src/main/java/org/apache/hadoop/hbase/catalog/CatalogTracker.java +++ b/src/main/java/org/apache/hadoop/hbase/catalog/CatalogTracker.java @@ -272,7 +272,7 @@ public class CatalogTracker { * Returns the current meta location unless its null. In this latter case, * it has not yet been set so go check whats up in -ROOT- and * return that. - * @return{@link ServerName} for server hosting .META. or if null, + * @return {@link ServerName} for server hosting .META. or if null, * we'll read the location that is up in -ROOT- table (which * could be null or just plain stale). * @throws IOException diff --git a/src/main/java/org/apache/hadoop/hbase/client/Result.java b/src/main/java/org/apache/hadoop/hbase/client/Result.java index 5d50841d91d..57f5ecb599e 100644 --- a/src/main/java/org/apache/hadoop/hbase/client/Result.java +++ b/src/main/java/org/apache/hadoop/hbase/client/Result.java @@ -60,8 +60,8 @@ import org.apache.hadoop.io.Writable; * A Result is backed by an array of {@link KeyValue} objects, each representing * an HBase cell defined by the row, family, qualifier, timestamp, and value.

* - * The underlying {@link KeyValue} objects can be accessed through the methods - * {@link #sorted()} and {@link #list()}. Each KeyValue can then be accessed + * The underlying {@link KeyValue} objects can be accessed through the method {@link #list()}. + * Each KeyValue can then be accessed * through {@link KeyValue#getRow()}, {@link KeyValue#getFamily()}, {@link KeyValue#getQualifier()}, * {@link KeyValue#getTimestamp()}, and {@link KeyValue#getValue()}. */ diff --git a/src/main/java/org/apache/hadoop/hbase/ipc/RequestContext.java b/src/main/java/org/apache/hadoop/hbase/ipc/RequestContext.java index 0e185a29e69..7de87c14db7 100644 --- a/src/main/java/org/apache/hadoop/hbase/ipc/RequestContext.java +++ b/src/main/java/org/apache/hadoop/hbase/ipc/RequestContext.java @@ -46,7 +46,7 @@ public class RequestContext { /** * Returns the user credentials associated with the current RPC request or * null if no credentials were provided. - * @return + * @return A User */ public static User getRequestUser() { RequestContext ctx = instance.get(); diff --git a/src/main/java/org/apache/hadoop/hbase/mapreduce/TableInputFormat.java b/src/main/java/org/apache/hadoop/hbase/mapreduce/TableInputFormat.java index ef19e6d8d38..3dcbf74fe97 100644 --- a/src/main/java/org/apache/hadoop/hbase/mapreduce/TableInputFormat.java +++ b/src/main/java/org/apache/hadoop/hbase/mapreduce/TableInputFormat.java @@ -168,7 +168,6 @@ implements Configurable { * Overrides previous calls to addFamily for any families in the input. * * @param columns array of columns, formatted as 

family:qualifier
- * @return this */ public static void addColumns(Scan scan, byte [][] columns) { for (byte[] column : columns) { @@ -192,4 +191,4 @@ implements Configurable { } } -} \ No newline at end of file +} diff --git a/src/main/java/org/apache/hadoop/hbase/security/User.java b/src/main/java/org/apache/hadoop/hbase/security/User.java index b0d1ab05768..eb516a4444a 100644 --- a/src/main/java/org/apache/hadoop/hbase/security/User.java +++ b/src/main/java/org/apache/hadoop/hbase/security/User.java @@ -149,7 +149,7 @@ public abstract class User { /** * Wraps an underlying {@code UserGroupInformation} instance. * @param ugi The base Hadoop user - * @return + * @return User */ public static User create(UserGroupInformation ugi) { if (ugi == null) { diff --git a/src/main/java/org/apache/hadoop/hbase/util/FSUtils.java b/src/main/java/org/apache/hadoop/hbase/util/FSUtils.java index c268365368a..07d88c53869 100644 --- a/src/main/java/org/apache/hadoop/hbase/util/FSUtils.java +++ b/src/main/java/org/apache/hadoop/hbase/util/FSUtils.java @@ -151,7 +151,6 @@ public abstract class FSUtils { /** * Check whether dfs is in safemode. * @param conf - * @return true if dfs is in safemode. * @throws IOException */ public static void checkDfsSafeMode(final Configuration conf) diff --git a/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKLeaderManager.java b/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKLeaderManager.java index c12c7ee3c81..f20179994cd 100644 --- a/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKLeaderManager.java +++ b/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKLeaderManager.java @@ -28,9 +28,9 @@ import org.apache.zookeeper.KeeperException; /** * Handles coordination of a single "leader" instance among many possible - * candidates. The first {@code ZKLeaderManager} to successfully create + * candidates. The first {@link ZKLeaderManager} to successfully create * the given znode becomes the leader, allowing the instance to continue - * with whatever processing must be protected. Other {@ZKLeaderManager} + * with whatever processing must be protected. Other {@link ZKLeaderManager} * instances will wait to be notified of changes to the leader znode. * If the current master instance fails, the ephemeral leader znode will * be removed, and all waiting instances will be notified, with the race diff --git a/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKUtil.java b/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKUtil.java index 960c9c1d920..d3d9836e6a7 100644 --- a/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKUtil.java +++ b/src/main/java/org/apache/hadoop/hbase/zookeeper/ZKUtil.java @@ -580,7 +580,7 @@ public class ZKUtil { * children, an empty list will be returned. * * @param zkw zk reference - * @param znode path of node to list and watch children of + * @param baseNode path of node to list and watch children of * @return list of data of children of the specified node, an empty list if the node * exists but has no children, and null if the node does not exist * @throws KeeperException if unexpected zookeeper exception