From cd314fbf96db8712d755f91989b80128670ed575 Mon Sep 17 00:00:00 2001 From: Elliott Clark Date: Fri, 21 Dec 2012 17:05:45 -0800 Subject: [PATCH] Fix javadoc warnings and set the allowed number to 0 --- dev-support/test-patch.properties | 2 +- .../org/apache/hadoop/hbase/client/coprocessor/Batch.java | 12 ++++++------ .../filter/FirstKeyValueMatchingQualifiersFilter.java | 3 ++- .../org/apache/hadoop/hbase/io/hfile/ChecksumUtil.java | 2 +- .../org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.java | 1 - .../org/apache/hadoop/hbase/protobuf/RequestConverter.java | 4 ++-- .../regionserver/ReplicationHLogReaderManager.java | 2 +- .../hadoop/hbase/security/access/AccessController.java | 4 ++-- .../apache/hadoop/hbase/security/token/TokenProvider.java | 4 ++-- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git dev-support/test-patch.properties dev-support/test-patch.properties index 3374978..3ad780a 100644 --- dev-support/test-patch.properties +++ dev-support/test-patch.properties @@ -20,4 +20,4 @@ MAVEN_OPTS="-Xmx3g" OK_RELEASEAUDIT_WARNINGS=84 OK_FINDBUGS_WARNINGS=517 -OK_JAVADOC_WARNINGS=169 +OK_JAVADOC_WARNINGS=0 diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/client/coprocessor/Batch.java hbase-server/src/main/java/org/apache/hadoop/hbase/client/coprocessor/Batch.java index 9ca4de6..c1b6e35 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/client/coprocessor/Batch.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/client/coprocessor/Batch.java @@ -37,15 +37,15 @@ public abstract class Batch { * *

* When used with - * {@link org.apache.hadoop.hbase.client.HTable#coprocessorExec(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)} + * {@link org.apache.hadoop.hbase.client.HTable#coprocessorService(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call)} * the implementations {@link Batch.Call#call(Object)} method will be invoked * with a proxy to the - * {@link org.apache.hadoop.hbase.ipc.CoprocessorProtocol} + * {@link org.apache.hadoop.hbase.coprocessor.CoprocessorService} * sub-type instance. *

* @see org.apache.hadoop.hbase.client.coprocessor - * @see org.apache.hadoop.hbase.client.HTable#coprocessorExec(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call) - * @see org.apache.hadoop.hbase.client.HTable#coprocessorExec(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback) + * @see org.apache.hadoop.hbase.client.HTable#coprocessorService(byte[]) + * @see org.apache.hadoop.hbase.client.HTable#coprocessorService(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call) * @param the instance type to be passed to * {@link Batch.Call#call(Object)} * @param the return type from {@link Batch.Call#call(Object)} @@ -60,13 +60,13 @@ public abstract class Batch { * *

* When used with - * {@link org.apache.hadoop.hbase.client.HTable#coprocessorExec(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback)}, + * {@link org.apache.hadoop.hbase.client.HTable#coprocessorService(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call)} * the implementation's {@link Batch.Callback#update(byte[], byte[], Object)} * method will be called with the {@link Batch.Call#call(Object)} return value * from each region in the selected range. *

* @param the return type from the associated {@link Batch.Call#call(Object)} - * @see org.apache.hadoop.hbase.client.HTable#coprocessorExec(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback) + * @see org.apache.hadoop.hbase.client.HTable#coprocessorService(Class, byte[], byte[], org.apache.hadoop.hbase.client.coprocessor.Batch.Call) */ public static interface Callback { public void update(byte[] region, byte[] row, R result); diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.java hbase-server/src/main/java/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.java index 501c267..f479420 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/filter/FirstKeyValueMatchingQualifiersFilter.java @@ -37,7 +37,8 @@ import java.util.TreeSet; *

* Note : It may emit KVs which do not have the given columns in them, if * these KVs happen to occur before a KV which does have a match. Given this - * caveat, this filter is only useful for special cases like {@link RowCounter}. + * caveat, this filter is only useful for special cases + * like {@link org.apache.hadoop.hbase.mapreduce.RowCounter}. *

*/ @InterfaceAudience.Public diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/ChecksumUtil.java hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/ChecksumUtil.java index 4ef1be7..4fc3576 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/ChecksumUtil.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/ChecksumUtil.java @@ -54,7 +54,7 @@ public class ChecksumUtil { * compute checkums from * @param endOffset ending offset in the indata stream upto * which checksums needs to be computed - * @param outData the output buffer where checksum values are written + * @param outdata the output buffer where checksum values are written * @param outOffset the starting offset in the outdata where the * checksum values are written * @param checksumType type of checksum diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.java hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.java index 5e98d31..4cf165e 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/FixedFileTrailer.java @@ -222,7 +222,6 @@ public class FixedFileTrailer { * {@link #serialize(DataOutputStream)}. * * @param inputStream - * @param version * @throws IOException */ void deserialize(DataInputStream inputStream) throws IOException { diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java index 95a57f0..e332ab1 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/protobuf/RequestConverter.java @@ -1137,7 +1137,7 @@ public final class RequestConverter { * @param family optional column family * @param qualifier optional qualifier * @param actions the permissions to be granted - * @return A {@link AccessControlProtos.GrantRequest) + * @return A {@link AccessControlProtos} GrantRequest */ public static AccessControlProtos.GrantRequest buildGrantRequest( String username, byte[] table, byte[] family, byte[] qualifier, @@ -1173,7 +1173,7 @@ public final class RequestConverter { * @param family optional column family * @param qualifier optional qualifier * @param actions the permissions to be revoked - * @return A {@link AccessControlProtos.RevokeRequest) + * @return A {@link AccessControlProtos} RevokeRequest */ public static AccessControlProtos.RevokeRequest buildRevokeRequest( String username, byte[] table, byte[] family, byte[] qualifier, diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/ReplicationHLogReaderManager.java hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/ReplicationHLogReaderManager.java index 0c274b0..5a43636 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/ReplicationHLogReaderManager.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/ReplicationHLogReaderManager.java @@ -57,7 +57,7 @@ public class ReplicationHLogReaderManager { /** * Opens the file at the current position * @param path - * @return + * @return an HLog reader. * @throws IOException */ public HLog.Reader openReader(Path path) throws IOException { diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java index 10413a0..6955fd3 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/security/access/AccessController.java @@ -92,13 +92,13 @@ import static org.apache.hadoop.hbase.protobuf.generated.AccessControlProtos.Acc * *

* To perform authorization checks, {@code AccessController} relies on the - * {@link org.apache.hadoop.hbase.ipc.SecureRpcEngine} being loaded to provide + * {@link org.apache.hadoop.hbase.ipc.RpcServerEngine} being loaded to provide * the user identities for remote requests. *

* *

* The access control lists used for authorization can be manipulated via the - * exposed {@link AccessControlService.Interface} implementation, and the associated + * exposed {@link AccessControlService} Interface implementation, and the associated * {@code grant}, {@code revoke}, and {@code user_permission} HBase shell * commands. *

diff --git hbase-server/src/main/java/org/apache/hadoop/hbase/security/token/TokenProvider.java hbase-server/src/main/java/org/apache/hadoop/hbase/security/token/TokenProvider.java index 2592701..7f3492a 100644 --- hbase-server/src/main/java/org/apache/hadoop/hbase/security/token/TokenProvider.java +++ hbase-server/src/main/java/org/apache/hadoop/hbase/security/token/TokenProvider.java @@ -44,7 +44,7 @@ import org.apache.hadoop.security.token.Token; /** * Provides a service for obtaining authentication tokens via the - * {@link AuthenticationProtos.AuthenticationService} coprocessor service. + * {@link AuthenticationProtos} AuthenticationService coprocessor service. */ public class TokenProvider implements AuthenticationProtos.AuthenticationService.Interface, Coprocessor, CoprocessorService { @@ -73,7 +73,7 @@ public class TokenProvider implements AuthenticationProtos.AuthenticationService } /** - * @param ugi + * @param ugi A user group information. * @return true if delegation token operation is allowed */ private boolean isAllowedDelegationTokenOp(UserGroupInformation ugi) throws IOException { -- 1.7.10.2 (Apple Git-33)