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
This commit is contained in:
Michael Stack 2011-11-19 22:11:17 +00:00
parent d47fd50da1
commit 72c3a34146
8 changed files with 9 additions and 11 deletions

View File

@ -60,8 +60,8 @@ import org.apache.hadoop.io.Writable;
* A Result is backed by an array of {@link KeyValue} objects, each representing * 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.<p> * an HBase cell defined by the row, family, qualifier, timestamp, and value.<p>
* *
* The underlying {@link KeyValue} objects can be accessed through the methods * The underlying {@link KeyValue} objects can be accessed through the method {@link #list()}.
* {@link #sorted()} and {@link #list()}. Each KeyValue can then be accessed * Each KeyValue can then be accessed
* through {@link KeyValue#getRow()}, {@link KeyValue#getFamily()}, {@link KeyValue#getQualifier()}, * through {@link KeyValue#getRow()}, {@link KeyValue#getFamily()}, {@link KeyValue#getQualifier()},
* {@link KeyValue#getTimestamp()}, and {@link KeyValue#getValue()}. * {@link KeyValue#getTimestamp()}, and {@link KeyValue#getValue()}.
*/ */

View File

@ -46,7 +46,7 @@ public class RequestContext {
/** /**
* Returns the user credentials associated with the current RPC request or * Returns the user credentials associated with the current RPC request or
* <code>null</code> if no credentials were provided. * <code>null</code> if no credentials were provided.
* @return * @return A User
*/ */
public static User getRequestUser() { public static User getRequestUser() {
RequestContext ctx = instance.get(); RequestContext ctx = instance.get();

View File

@ -168,7 +168,6 @@ implements Configurable {
* Overrides previous calls to addFamily for any families in the input. * Overrides previous calls to addFamily for any families in the input.
* *
* @param columns array of columns, formatted as <pre>family:qualifier</pre> * @param columns array of columns, formatted as <pre>family:qualifier</pre>
* @return this
*/ */
public static void addColumns(Scan scan, byte [][] columns) { public static void addColumns(Scan scan, byte [][] columns) {
for (byte[] column : columns) { for (byte[] column : columns) {

View File

@ -149,7 +149,7 @@ public abstract class User {
/** /**
* Wraps an underlying {@code UserGroupInformation} instance. * Wraps an underlying {@code UserGroupInformation} instance.
* @param ugi The base Hadoop user * @param ugi The base Hadoop user
* @return * @return User
*/ */
public static User create(UserGroupInformation ugi) { public static User create(UserGroupInformation ugi) {
if (ugi == null) { if (ugi == null) {

View File

@ -151,7 +151,6 @@ public abstract class FSUtils {
/** /**
* Check whether dfs is in safemode. * Check whether dfs is in safemode.
* @param conf * @param conf
* @return true if dfs is in safemode.
* @throws IOException * @throws IOException
*/ */
public static void checkDfsSafeMode(final Configuration conf) public static void checkDfsSafeMode(final Configuration conf)

View File

@ -28,9 +28,9 @@ import org.apache.zookeeper.KeeperException;
/** /**
* Handles coordination of a single "leader" instance among many possible * 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 * 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. * instances will wait to be notified of changes to the leader znode.
* If the current master instance fails, the ephemeral leader znode will * If the current master instance fails, the ephemeral leader znode will
* be removed, and all waiting instances will be notified, with the race * be removed, and all waiting instances will be notified, with the race

View File

@ -580,7 +580,7 @@ public class ZKUtil {
* children, an empty list will be returned. * children, an empty list will be returned.
* *
* @param zkw zk reference * @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 * @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 * exists but has no children, and null if the node does not exist
* @throws KeeperException if unexpected zookeeper exception * @throws KeeperException if unexpected zookeeper exception