Skip to content

Commit 8c2dd12

Browse files
committed
HBASE-27401 Clean up current broken 'n's in our javadoc (#4812)
Signed-off-by: Andrew Purtell <apurtell@apache.org> (cherry picked from commit 63cdd02) Conflicts: hbase-backup/src/main/java/org/apache/hadoop/hbase/backup/impl/BackupManager.java hbase-client/src/main/java/org/apache/hadoop/hbase/HRegionLocation.java hbase-client/src/main/java/org/apache/hadoop/hbase/client/Append.java hbase-client/src/main/java/org/apache/hadoop/hbase/client/Mutation.java hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java hbase-client/src/main/java/org/apache/hadoop/hbase/filter/SingleColumnValueExcludeFilter.java hbase-client/src/main/java/org/apache/hadoop/hbase/filter/SingleColumnValueFilter.java hbase-client/src/main/java/org/apache/hadoop/hbase/security/visibility/VisibilityClient.java hbase-client/src/main/java/org/apache/hadoop/hbase/shaded/protobuf/RequestConverter.java hbase-common/src/main/java/org/apache/hadoop/hbase/CellUtil.java hbase-it/src/test/java/org/apache/hadoop/hbase/test/IntegrationTestReplication.java hbase-rest/src/test/java/org/apache/hadoop/hbase/rest/client/TestRemoteTable.java hbase-rsgroup/src/main/java/org/apache/hadoop/hbase/rsgroup/RSGroupInfoManager.java hbase-server/src/main/java/org/apache/hadoop/hbase/HBaseServerBase.java hbase-server/src/main/java/org/apache/hadoop/hbase/coprocessor/MasterObserver.java hbase-server/src/main/java/org/apache/hadoop/hbase/mob/MobUtils.java hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/flush/RegionServerFlushTableProcedureManager.java hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/Region.java hbase-server/src/main/java/org/apache/hadoop/hbase/replication/HBaseReplicationEndpoint.java hbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/MetricsSource.java hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestingUtil.java hbase-server/src/test/java/org/apache/hadoop/hbase/HBaseTestingUtility.java hbase-server/src/test/java/org/apache/hadoop/hbase/tool/TestBulkLoadHFilesSplitRecovery.java hbase-thrift/src/main/java/org/apache/hadoop/hbase/thrift/ThriftUtilities.java
1 parent 9d7614b commit 8c2dd12

612 files changed

Lines changed: 2991 additions & 2886 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

hbase-asyncfs/src/main/java/org/apache/hadoop/hbase/io/asyncfs/FanOutOneBlockAsyncDFSOutputSaslHelper.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ private static class BuilderPayloadSetter {
367367
* Create a ByteString from byte array without copying (wrap), and then set it as the payload
368368
* for the builder.
369369
* @param builder builder for HDFS DataTransferEncryptorMessage.
370-
* @param payload byte array of payload. n
370+
* @param payload byte array of payload.
371371
*/
372372
static void wrapAndSetPayload(DataTransferEncryptorMessageProto.Builder builder,
373373
byte[] payload) throws IOException {

hbase-client/src/main/java/org/apache/hadoop/hbase/AsyncMetaTableAccessor.java

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,8 @@ public static CompletableFuture<Optional<TableState>> getTableState(AsyncTable<?
102102
}
103103

104104
/**
105-
* Returns the HRegionLocation from meta for the given region n * @param regionName region we're
106-
* looking for
105+
* Returns the HRegionLocation from meta for the given region
106+
* @param regionName region we're looking for
107107
* @return HRegionLocation for the given region
108108
*/
109109
public static CompletableFuture<Optional<HRegionLocation>>
@@ -128,8 +128,8 @@ public static CompletableFuture<Optional<TableState>> getTableState(AsyncTable<?
128128
}
129129

130130
/**
131-
* Returns the HRegionLocation from meta for the given encoded region name n * @param
132-
* encodedRegionName region we're looking for
131+
* Returns the HRegionLocation from meta for the given encoded region name
132+
* @param encodedRegionName region we're looking for
133133
* @return HRegionLocation for the given region
134134
*/
135135
public static CompletableFuture<Optional<HRegionLocation>>
@@ -176,8 +176,8 @@ private static Optional<TableState> getTableState(Result r) throws IOException {
176176
}
177177

178178
/**
179-
* Used to get all region locations for the specific table. n * @param tableName table we're
180-
* looking for, can be null for getting all regions
179+
* Used to get all region locations for the specific table.
180+
* @param tableName table we're looking for, can be null for getting all regions
181181
* @return the list of region locations. The return value will be wrapped by a
182182
* {@link CompletableFuture}.
183183
*/
@@ -200,8 +200,8 @@ public static CompletableFuture<List<HRegionLocation>> getTableHRegionLocations(
200200
}
201201

202202
/**
203-
* Used to get table regions' info and server. n * @param tableName table we're looking for, can
204-
* be null for getting all regions
203+
* Used to get table regions' info and server.
204+
* @param tableName table we're looking for, can be null for getting all regions
205205
* @param excludeOfflinedSplitParents don't return split parents
206206
* @return the list of regioninfos and server. The return value will be wrapped by a
207207
* {@link CompletableFuture}.
@@ -259,9 +259,10 @@ void add(Result r) {
259259
}
260260

261261
/**
262-
* Performs a scan of META table for given table. n * @param tableName table withing we scan
263-
* @param type scanned part of meta
264-
* @param visitor Visitor invoked against each row
262+
* Performs a scan of META table for given table.
263+
* @param tableName table withing we scan
264+
* @param type scanned part of meta
265+
* @param visitor Visitor invoked against each row
265266
*/
266267
private static CompletableFuture<Void> scanMeta(AsyncTable<AdvancedScanResultConsumer> metaTable,
267268
TableName tableName, QueryType type, final Visitor visitor) {
@@ -270,11 +271,12 @@ private static CompletableFuture<Void> scanMeta(AsyncTable<AdvancedScanResultCon
270271
}
271272

272273
/**
273-
* Performs a scan of META table for given table. n * @param startRow Where to start the scan
274-
* @param stopRow Where to stop the scan
275-
* @param type scanned part of meta
276-
* @param maxRows maximum rows to return
277-
* @param visitor Visitor invoked against each row
274+
* Performs a scan of META table for given table.
275+
* @param startRow Where to start the scan
276+
* @param stopRow Where to stop the scan
277+
* @param type scanned part of meta
278+
* @param maxRows maximum rows to return
279+
* @param visitor Visitor invoked against each row
278280
*/
279281
private static CompletableFuture<Void> scanMeta(AsyncTable<AdvancedScanResultConsumer> metaTable,
280282
byte[] startRow, byte[] stopRow, QueryType type, int maxRows, final Visitor visitor) {

hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterId.java

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ public byte[] toByteArray() {
5252

5353
/**
5454
* @param bytes A pb serialized {@link ClusterId} instance with pb magic prefix
55-
* @return An instance of {@link ClusterId} made from <code>bytes</code> n * @see #toByteArray()
55+
* @return An instance of {@link ClusterId} made from <code>bytes</code>
56+
* @see #toByteArray()
5657
*/
5758
public static ClusterId parseFrom(final byte[] bytes) throws DeserializationException {
5859
if (ProtobufUtil.isPBMagicPrefix(bytes)) {
@@ -78,9 +79,7 @@ public ClusterIdProtos.ClusterId convert() {
7879
return builder.setClusterId(this.id).build();
7980
}
8081

81-
/**
82-
* n * @return A {@link ClusterId} made from the passed in <code>cid</code>
83-
*/
82+
/** Returns A {@link ClusterId} made from the passed in <code>cid</code> */
8483
public static ClusterId convert(final ClusterIdProtos.ClusterId cid) {
8584
return new ClusterId(cid.getClusterId());
8685
}

hbase-client/src/main/java/org/apache/hadoop/hbase/ClusterStatus.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ public List<ServerName> getBackupMasters() {
269269
}
270270

271271
/**
272-
* n * @return Server's load or null if not found.
272+
* @return Server's load or null if not found.
273273
* @deprecated As of release 2.0.0, this will be removed in HBase 3.0.0 Use
274274
* {@link #getLiveServerMetrics} instead.
275275
*/

hbase-client/src/main/java/org/apache/hadoop/hbase/HColumnDescriptor.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -358,8 +358,8 @@ public HColumnDescriptor setDataBlockEncoding(DataBlockEncoding value) {
358358

359359
/**
360360
* Set whether the tags should be compressed along with DataBlockEncoding. When no
361-
* DataBlockEncoding is been used, this is having no effect. n * @return this (for chained
362-
* invocation)
361+
* DataBlockEncoding is been used, this is having no effect.
362+
* @return this (for chained invocation)
363363
*/
364364
public HColumnDescriptor setCompressTags(boolean value) {
365365
getDelegateeForModification().setCompressTags(value);
@@ -668,8 +668,8 @@ public byte[] toByteArray() {
668668

669669
/**
670670
* @param bytes A pb serialized {@link HColumnDescriptor} instance with pb magic prefix
671-
* @return An instance of {@link HColumnDescriptor} made from <code>bytes</code> n * @see
672-
* #toByteArray()
671+
* @return An instance of {@link HColumnDescriptor} made from <code>bytes</code>
672+
* @see #toByteArray()
673673
*/
674674
public static HColumnDescriptor parseFrom(final byte[] bytes) throws DeserializationException {
675675
ColumnFamilyDescriptor desc = ColumnFamilyDescriptorBuilder.parseFrom(bytes);
@@ -713,7 +713,7 @@ public String getEncryptionType() {
713713
}
714714

715715
/**
716-
* Set the encryption algorithm for use with this family n
716+
* Set the encryption algorithm for use with this family
717717
*/
718718
public HColumnDescriptor setEncryptionType(String value) {
719719
getDelegateeForModification().setEncryptionType(value);

0 commit comments

Comments
 (0)