[ 
https://issues.apache.org/jira/browse/HBASE-27401?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17611926#comment-17611926
 ] 

Duo Zhang edited comment on HBASE-27401 at 10/1/22 4:10 PM:
------------------------------------------------------------

And I've added a check for finding the broken javadoc line where we trim the 
javadoc incorrectly, with code like this

{code}
        if (line.trim().substring(1).contains(" * ") || line.trim().endsWith(" 
*")) {
          System.out.println(path + ":" + line);
        }
{code}

This is the output, not too many so let me fix them manually.

{noformat}
/home/zhangduo/hbase/code/hbase-balancer/src/main/java/org/apache/hadoop/hbase/master/balancer/HeterogeneousRegionCountCostFunction.java:
 * * rs[0-9] 200 * rs1[0-9] 50
/home/zhangduo/hbase/code/hbase-balancer/src/main/java/org/apache/hadoop/hbase/master/balancer/RegionReplicaGroupingCostFunction.java:
   * d, e, f where a and b are same replicas, and c,d,e are same replicas, it 
returns (2-1) * (2-1)
/home/zhangduo/hbase/code/hbase-balancer/src/main/java/org/apache/hadoop/hbase/master/balancer/RegionReplicaGroupingCostFunction.java:
   * + (3-1) * (3-1) + (1-1) * (1-1).
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/master/cleaner/CleanerChore.java:
   * processors * size. Pay attention that 1.0 is different from 1, former 
indicates it will use
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.java:
 * <li>For each region R0, if R0 is bigger than S * 2, it is kindly requested 
to split.</li>
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/master/SplitWALManager.java:
 * {@link SplitWALProcedure}. Total number of workers is (number of online 
servers) *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/LruBlockCache.java:
   * Hard capacity limit of cache, will reject any put if size > this * 
acceptable
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/package-info.java:
 * usually means less GC headache), try enabling * BucketCache. Fetching will 
always
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/bucket/BucketCache.java:
   * blocks requested * (1 + extraFreeFactor)
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/bucket/ByteBufferIOEngine.java:
 * divided by 4 (hard-coded currently) * max size option. So using defaults, 
buckets will be is 4 *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/bucket/BucketAllocator.java:
     * Combined {@link #totalCount()} * {@link #itemSize()}
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/LruAdaptiveBlockCache.java:
 * Sum (MB) * 100 / Limit (MB) - 100; For example we set the limit = 500 and 
were evicted 2000 MB.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/LruAdaptiveBlockCache.java:
 * Overhead is: 2000 * 100 / 500 - 100 = 300% The feature is going to reduce a 
percent caching data
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/LruAdaptiveBlockCache.java:
 * bytes less then the limit we have got negative overhead. For example if were 
freed 200 MB: 200 *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/LruAdaptiveBlockCache.java:
   * Hard capacity limit of cache, will reject any put if size > this * 
acceptable
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/PreviousBlockCompressionRatePredicator.java:
   * BLOCK_SIZE * (uncompressed/compressed).
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/throttle/PressureAwareCompactionThroughputController.java:
 * (higer - lower) * compactionPressure&quot;, where compactionPressure is in 
range [0.0, 1.0]</li>
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/throttle/PressureAwareFlushThroughputController.java:
 * lower) * flushPressure&quot;, where flushPressure is in range [0.0, 1.0)</li>
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/SteppingSplitPolicy.java:
   * @return flushSize * 2 if there's exactly one region of the table in 
question found on this
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/ExploringCompactionPolicy.java:
   * FileSize(i) <= ( Sum(0,N,FileSize(_)) - FileSize(i)) * Ratio.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/SortedCompactionPolicy.java:
     * is, +/- 3.5 days (7 days * 0.5).
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/CellFlatMap.java:
   * of the output is the possible insert index for the searched key In 
twos-complement, (-1 *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StoreConfigInformation.java:
   *         multiplier * HConstants.THREAD_WAKE_FREQUENCY milliseconds.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/IncreasingToUpperBoundRegionSplitPolicy.java:
 * make two regions that will split when their size is {@code 2^3 * 128MB*2 = 
2048MB}.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/IncreasingToUpperBoundRegionSplitPolicy.java:
 * {@code 3^3 * 128MB*2 = 6912MB}, and so on until we reach the configured 
maximum file size and
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/IncreasingToUpperBoundRegionSplitPolicy.java:
   * @return Region max size or {@code count of regions cubed * 2 * flushsize}, 
which ever is
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/wal/AbstractFSWAL.java:
 * {@link WALFactory#createReader(org.apache.hadoop.fs.FileSystem, 
org.apache.hadoop.fs.Path)}. *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/BloomFilter.java:
 * of entries, then the optimal bloom size m = -(n * ln(err) / (ln(2)^2) ~= 
ln(err) / ln(0.6185) The
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/RegionSplitCalculator.java:
   * This is a map from start key to regions with the same start key. 
Invariant: This always have *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/LossyCounting.java:
 * does not appear in set, then is frequency is less than e * N (N is total 
element counts until
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/BloomFilterUtil.java:
   * Increases the given byte size of a Bloom filter until it can be folded by 
the given factor. *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/BloomFilterUtil.java:
   * * @return Foldable byte size
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/RegionMover.java:
     * Path of file where regions will be written to during unloading/read from 
during loading *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/RegionMover.java:
     * * @return RegionMoverBuilder object
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/RegionMover.java:
     * movers also have a separate time which is hbase.move.wait.max * number 
of regions to
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinatorRpcs.java:
   * Initialize and start threads necessary to connect an implementation's rpc 
mechanisms. *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinatorRpcs.java:
   * * @return true if succeed, false if encountered initialization errors.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/quotas/QuotaCache.java:
     * over table quota, use [1 / TotalTableRegionNum * MachineTableRegionNum] 
as machine factor.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/ipc/SimpleRpcServerResponder.java:
   * @return true if all the calls were processed or that someone else is doing 
it. false if there *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/wal/WALKeyImpl.java:
   * @param clusterIds        the clusters that have consumed the change(used 
in Replication) *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/wal/WALKeyImpl.java:
   *                          * @param mvcc mvcc control used to generate 
sequence numbers and
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterTransitions.java:
   * private int closeCount = 0; static final int SERVER_DURATION = 3 * 1000; 
static final int
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterTransitions.java:
   * CLOSE_DURATION = 1 * 1000; HBase2428Listener(final MiniHBaseCluster c, 
final HServerAddress
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterTransitions.java:
     * ((HBase2428Listener.SERVER_DURATION/HBase2428Listener.CLOSE_DURATION) * 
2)); // Assert the
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterTransitions.java:
     * countOfMetaRegions/(cluster.getRegionServerThreads().size() * 2); while
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/normalizer/TestSimpleRegionNormalizerOnCluster.java:
   * <li>split threshold: 2.4 * 2 = 4.8</li>
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterFailoverBalancerPersistence.java:
   * @return the new active master * * @throws java.io.IOException
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/mob/TestMobCompactionRegularRegionBatchMode.java:
 * 20. 12 Runs scanner and checks all 3 * 1000 rows.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/mob/TestMobCompactionOptRegionBatchMode.java:
 * files in a mob directory is 20. 12 Runs scanner and checks all 3 * 1000 rows.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/mob/TestMobCompactionOptMode.java:
 * mob directory is 20. 12 Runs scanner and checks all 3 * 1000 rows.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/mob/TestMobCompactionWithDefaults.java:
 * scanner and checks all 3 * 1000 rows.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/TestMultiColumnScanner.java:
 * scan will check the ROWCOL bloom filter 20 (rows)* 8 (column) * 10 (hfiles)= 
1600 times, beside
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/compactions/PerfTestCompactionPolicies.java:
      * fileListGenClasses.length * policyClasses.length);
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/TestSyncTimeRangeTracker.java:
   * * 10k and min is 0.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/filter/TestFiltersWithBinaryComponentComparator.java:
   * Since we are trying to emulate SQL: SELECT * from table where a = 1 and b 
> 10 and b < 20 and c
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/wal/TestWALSplit.java:
   * fed. * After the split is complete, verifies that the statistics show the 
correct number of
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * 
[spec](http://bibnum.bnf.fr/warc/WARC_ISO_28500_version1_latestdraft.pdf)) * 
`warcinfo`:
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * `"application/warc-fields"` content-type is recommended. (...) * 
`response`: The record
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * 'entity-body' (per RFC2616), with any transfer-encoding removed. * 
`resource`: The record
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * with any transfer-encodings removed), possibly truncated. * `request`: 
The record holds the
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * transfer-encoding removed. * `metadata`: The record contains content 
created in order to
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * metadata record block may vary. The `"application/warc-fields"` format 
may be used. *
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * specification for details. * `conversion`: The record shall contain an 
alternative version of
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * information usable with current tools while minimizing loss of 
information. * `continuation`:
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * see the specification for details. * Other record types may be added in 
future, so this list
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/IntegrationTestReplication.java:
   * The number of nodes in the test setup. This has to be a multiple of 
WRAP_MULTIPLIER * WIDTH in
/home/zhangduo/hbase/code/hbase-procedure/src/main/java/org/apache/hadoop/hbase/procedure2/store/wal/BitSetNode.java:
 * of a {@link BitSetNode} is from [x * K, y * K) where x and y are integers, y 
> x and K is
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/Cell.java:
   * non-negative number, to make good use of the sign bit, the max of tags 
length is defined 2 *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/ByteBuff.java:
   * * @return the byte at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * Fetches the byte at the given index. Does not change position of the 
underlying ByteBuffers *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * * @return the byte at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * Fetches the int at the given index. Does not change position of the 
underlying ByteBuffers *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * * @return the int value at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * Fetches the short at the given index. Does not change position of the 
underlying ByteBuffers *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * * @return the short value at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * Fetches the long at the given index. Does not change position of the 
underlying ByteBuffers *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * * @return the long value at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/io/util/LRUDictionary.java:
 * <code>(2 ^ 15) * 5 (Regionname, Row key, CF, Column qual, table) * 100 bytes
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/util/ChecksumType.java:
   * Cannot rely on enum ordinals . They change if item is removed or moved. Do 
our own codes. *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/util/ChecksumType.java:
   * * @return Type associated with passed code.
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/util/OrderedBytes.java:
   * The original value is equal to {@code (M * 100^E)}. {@code E} is set to 
the smallest value
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/util/OrderedBytes.java:
   * The original value is equal to {@code (M * 100^E)}. {@code E} is set to 
the smallest value
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/ArrayBackedTag.java:
   * (Short.MAX_SIZE * 2) +1. It includes 1 byte type length and actual tag 
bytes length.
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/ExtendedCell.java:
   * non-negative number, to make good use of the sign bit, the max of tags 
length is defined 2 *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/types/CopyOnWriteArrayMap.java:
     *         (-1 * insertion point) - 1
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java:
   * * @return an int greater than 0 if left &gt; than right lesser than 0 if 
left &lt; than right
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java:
   * Create a Cell that is smaller than all other possible Cells for the given 
Cell's row. *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java:
   * * @return First possible Cell on passed Cell's row.
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java:
   * Create a Cell that is larger than all other possible Cells for the given 
Cell's row. *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java:
   * * @return Last possible Cell on passed Cell's row.
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/KeyValueUtil.java:
   * Write out a KeyValue in the manner in which we used to when KeyValue was a 
Writable. *
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/KeyValueUtil.java:
   * * @return Length written on stream
/home/zhangduo/hbase/code/hbase-common/src/test/java/org/apache/hadoop/hbase/util/TestOrderedBytes.java:
       * decoded length, encoded length ceil((n bytes * 8 bits/input byte) / 7 
bits/encoded byte) +
/home/zhangduo/hbase/code/hbase-common/src/test/java/org/apache/hadoop/hbase/Waiter.java:
   * The actual time out value will equal to hbase.test.wait.for.ratio * 
passed-in timeout
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java:
   *          currently, but this may change in the future. An * {@link 
IllegalArgumentException}
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java:
   * @param rowPrefix the prefix all rows must start with. (Set <i>null</i> to 
remove the filter.) *
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java:
   *                  * @deprecated since 2.5.0, will be removed in 4.0.0. The 
name of this method
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptorBuilder.java:
     * @return An instance of {@link ModifyableTableDescriptor} made from 
<code>bytes</code> *
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptorBuilder.java:
     *         * @see #toByteArray()
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncTableResultScanner.java:
 * {@code 2 * scan.getMaxResultSize()}.
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FilterBase.java:
   * Default implementation so that writers of custom filters aren't forced to 
implement. *
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FilterBase.java:
   * * @return true if and only if the fields of the filter that are serialized 
are equal to the
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlUtil.java:
   * @param userName   User name, if empty then all user permissions will be 
retrieved. *
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlUtil.java:
   *                   * @deprecated Use {@link 
Admin#getUserPermissions(GetUserPermissionsRequest)}
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlUtil.java:
   * @param userName        User name, if empty then all user permissions will 
be retrieved. *
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlUtil.java:
   *                        * @deprecated Use
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlUtil.java:
   * @param userName   User name, if empty then all user permissions will be 
retrieved. *
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlUtil.java:
   *                   * @deprecated Use {@link 
Admin#getUserPermissions(GetUserPermissionsRequest)}
/home/zhangduo/hbase/code/hbase-testing-util/src/main/java/org/apache/hadoop/hbase/MiniHBaseCluster.java:
   * Wait for the specified master to stop. Removes this thread from list of 
running threads. *
/home/zhangduo/hbase/code/hbase-testing-util/src/main/java/org/apache/hadoop/hbase/MiniHBaseCluster.java:
   * * @return Name of master that just went down.
/home/zhangduo/hbase/code/hbase-testing-util/src/main/java/org/apache/hadoop/hbase/HBaseTestingUtility.java:
   * Find any other region server which is different from the one identified by 
parameter *
/home/zhangduo/hbase/code/hbase-testing-util/src/main/java/org/apache/hadoop/hbase/HBaseTestingUtility.java:
   * * @return another region server
/home/zhangduo/hbase/code/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/TableInputFormatBase.java:
   * @return A list of TableSplit, the size of the list is * @throws 
IllegalArgumentIOException
/home/zhangduo/hbase/code/hbase-thrift/src/test/java/org/apache/hadoop/hbase/thrift2/TestThriftHBaseServiceHandlerWithLabels.java:
   * Padding numbers to make comparison of sort order easier in a for loop The 
number to pad. * *
/home/zhangduo/hbase/code/hbase-http/src/main/java/org/apache/hadoop/hbase/util/JSONMetricUtil.java:
   * @return Map or null if arrays are empty * or have different number of 
elements
{noformat}


was (Author: apache9):
And I've added a check for finding the broken javadoc line where we trim the 
javadoc incorrectly, with code like this

{code}
        if (line.trim().substring(1).contains(" * ")) {
          System.out.println(path + ":" + line);
        }
{code}

This is the output, not too many so let me fix them manually.

{noformat}
/home/zhangduo/hbase/code/hbase-balancer/src/main/java/org/apache/hadoop/hbase/master/balancer/HeterogeneousRegionCountCostFunction.java:
 * * rs[0-9] 200 * rs1[0-9] 50
/home/zhangduo/hbase/code/hbase-balancer/src/main/java/org/apache/hadoop/hbase/master/balancer/RegionReplicaGroupingCostFunction.java:
   * d, e, f where a and b are same replicas, and c,d,e are same replicas, it 
returns (2-1) * (2-1)
/home/zhangduo/hbase/code/hbase-balancer/src/main/java/org/apache/hadoop/hbase/master/balancer/RegionReplicaGroupingCostFunction.java:
   * + (3-1) * (3-1) + (1-1) * (1-1).
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/master/cleaner/CleanerChore.java:
   * processors * size. Pay attention that 1.0 is different from 1, former 
indicates it will use
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/master/MasterCoprocessorHost.java:
   * This will be called before update META step as part of split table region 
procedure. * * @param
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/master/normalizer/SimpleRegionNormalizer.java:
 * <li>For each region R0, if R0 is bigger than S * 2, it is kindly requested 
to split.</li>
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/LruBlockCache.java:
   * Hard capacity limit of cache, will reject any put if size > this * 
acceptable
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/package-info.java:
 * usually means less GC headache), try enabling * BucketCache. Fetching will 
always
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/bucket/BucketCache.java:
   * blocks requested * (1 + extraFreeFactor)
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/bucket/ByteBufferIOEngine.java:
 * divided by 4 (hard-coded currently) * max size option. So using defaults, 
buckets will be is 4 *
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/bucket/BucketAllocator.java:
     * Combined {@link #totalCount()} * {@link #itemSize()}
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/LruAdaptiveBlockCache.java:
 * Sum (MB) * 100 / Limit (MB) - 100; For example we set the limit = 500 and 
were evicted 2000 MB.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/LruAdaptiveBlockCache.java:
 * Overhead is: 2000 * 100 / 500 - 100 = 300% The feature is going to reduce a 
percent caching data
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/LruAdaptiveBlockCache.java:
   * Hard capacity limit of cache, will reject any put if size > this * 
acceptable
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/io/hfile/PreviousBlockCompressionRatePredicator.java:
   * BLOCK_SIZE * (uncompressed/compressed).
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/throttle/PressureAwareCompactionThroughputController.java:
 * (higer - lower) * compactionPressure&quot;, where compactionPressure is in 
range [0.0, 1.0]</li>
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/throttle/PressureAwareFlushThroughputController.java:
 * lower) * flushPressure&quot;, where flushPressure is in range [0.0, 1.0)</li>
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/SteppingSplitPolicy.java:
   * @return flushSize * 2 if there's exactly one region of the table in 
question found on this
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/ExploringCompactionPolicy.java:
   * ) * Ratio.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/compactions/SortedCompactionPolicy.java:
     * is, +/- 3.5 days (7 days * 0.5).
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/StoreConfigInformation.java:
   *         multiplier * HConstants.THREAD_WAKE_FREQUENCY milliseconds.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegionFileSystem.java:
   * * @return the result of fs.mkdirs(). In case underlying fs throws an 
IOException, it checks
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegionFileSystem.java:
   * * @return true if rename is successful.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/HRegionFileSystem.java:
   * * @return true if the directory is deleted.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/IncreasingToUpperBoundRegionSplitPolicy.java:
 * make two regions that will split when their size is {@code 2^3 * 128MB*2 = 
2048MB}.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/IncreasingToUpperBoundRegionSplitPolicy.java:
 * {@code 3^3 * 128MB*2 = 6912MB}, and so on until we reach the configured 
maximum file size and
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/regionserver/IncreasingToUpperBoundRegionSplitPolicy.java:
   * @return Region max size or {@code count of regions cubed * 2 * flushsize}, 
which ever is
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/BloomFilter.java:
 * of entries, then the optimal bloom size m = -(n * ln(err) / (ln(2)^2) ~= 
ln(err) / ln(0.6185) The
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/LossyCounting.java:
 * does not appear in set, then is frequency is less than e * N (N is total 
element counts until
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/BloomFilterUtil.java:
   * * @return Foldable byte size
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/RegionMover.java:
     * * @return RegionMoverBuilder object
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/util/RegionMover.java:
     * movers also have a separate time which is hbase.move.wait.max * number 
of regions to
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/procedure/ProcedureCoordinatorRpcs.java:
   * * @return true if succeed, false if encountered initialization errors.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/quotas/QuotaCache.java:
     * over table quota, use [1 / TotalTableRegionNum * MachineTableRegionNum] 
as machine factor.
/home/zhangduo/hbase/code/hbase-server/src/main/java/org/apache/hadoop/hbase/wal/WALKeyImpl.java:
   *                          * @param mvcc mvcc control used to generate 
sequence numbers and
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterTransitions.java:
   * private int closeCount = 0; static final int SERVER_DURATION = 3 * 1000; 
static final int
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterTransitions.java:
   * CLOSE_DURATION = 1 * 1000; HBase2428Listener(final MiniHBaseCluster c, 
final HServerAddress
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterTransitions.java:
     * ((HBase2428Listener.SERVER_DURATION/HBase2428Listener.CLOSE_DURATION) * 
2)); // Assert the
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterTransitions.java:
     * countOfMetaRegions/(cluster.getRegionServerThreads().size() * 2); while
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/normalizer/TestSimpleRegionNormalizerOnCluster.java:
   * <li>split threshold: 2.4 * 2 = 4.8</li>
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/master/TestMasterFailoverBalancerPersistence.java:
   * @return the new active master * * @throws java.io.IOException
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/mob/TestMobCompactionRegularRegionBatchMode.java:
 * 20. 12 Runs scanner and checks all 3 * 1000 rows.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/mob/TestMobCompactionOptRegionBatchMode.java:
 * files in a mob directory is 20. 12 Runs scanner and checks all 3 * 1000 rows.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/mob/TestMobCompactionOptMode.java:
 * mob directory is 20. 12 Runs scanner and checks all 3 * 1000 rows.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/mob/TestMobCompactionWithDefaults.java:
 * scanner and checks all 3 * 1000 rows.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/TestMultiColumnScanner.java:
 * scan will check the ROWCOL bloom filter 20 (rows)* 8 (column) * 10 (hfiles)= 
1600 times, beside
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/compactions/PerfTestCompactionPolicies.java:
      * fileListGenClasses.length * policyClasses.length);
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/TestSyncTimeRangeTracker.java:
   * * 10k and min is 0.
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/filter/TestFiltersWithBinaryComponentComparator.java:
   * Since we are trying to emulate SQL: SELECT * from table where a = 1 and b 
> 10 and b < 20 and c
/home/zhangduo/hbase/code/hbase-server/src/test/java/org/apache/hadoop/hbase/wal/TestWALSplit.java:
   * fed. * After the split is complete, verifies that the statistics show the 
correct number of
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * 
[spec](http://bibnum.bnf.fr/warc/WARC_ISO_28500_version1_latestdraft.pdf)) * 
`warcinfo`:
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * `"application/warc-fields"` content-type is recommended. (...) * 
`response`: The record
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * 'entity-body' (per RFC2616), with any transfer-encoding removed. * 
`resource`: The record
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * with any transfer-encodings removed), possibly truncated. * `request`: 
The record holds the
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * transfer-encoding removed. * `metadata`: The record contains content 
created in order to
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * specification for details. * `conversion`: The record shall contain an 
alternative version of
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * information usable with current tools while minimizing loss of 
information. * `continuation`:
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/util/warc/WARCRecord.java:
     * see the specification for details. * Other record types may be added in 
future, so this list
/home/zhangduo/hbase/code/hbase-it/src/test/java/org/apache/hadoop/hbase/test/IntegrationTestReplication.java:
   * The number of nodes in the test setup. This has to be a multiple of 
WRAP_MULTIPLIER * WIDTH in
/home/zhangduo/hbase/code/hbase-procedure/src/main/java/org/apache/hadoop/hbase/procedure2/store/wal/BitSetNode.java:
 * of a {@link BitSetNode} is from [x * K, y * K) where x and y are integers, y 
> x and K is
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/ByteBuff.java:
   * * @return the byte at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * * @return the byte at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * * @return the int value at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * * @return the short value at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/nio/MultiByteBuff.java:
   * * @return the long value at the given index
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/io/util/LRUDictionary.java:
 * <code>(2 ^ 15) * 5 (Regionname, Row key, CF, Column qual, table) * 100 bytes
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/util/ChecksumType.java:
   * * @return Type associated with passed code.
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/util/OrderedBytes.java:
   * The original value is equal to {@code (M * 100^E)}. {@code E} is set to 
the smallest value
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/util/OrderedBytes.java:
   * The original value is equal to {@code (M * 100^E)}. {@code E} is set to 
the smallest value
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/ArrayBackedTag.java:
   * (Short.MAX_SIZE * 2) +1. It includes 1 byte type length and actual tag 
bytes length.
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/types/CopyOnWriteArrayMap.java:
     *         (-1 * insertion point) - 1
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java:
   * * @return an int greater than 0 if left &gt; than right lesser than 0 if 
left &lt; than right
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java:
   * * @return First possible Cell on passed Cell's row.
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java:
   * * @return Last possible Cell on passed Cell's row.
/home/zhangduo/hbase/code/hbase-common/src/main/java/org/apache/hadoop/hbase/KeyValueUtil.java:
   * * @return Length written on stream
/home/zhangduo/hbase/code/hbase-common/src/test/java/org/apache/hadoop/hbase/util/TestOrderedBytes.java:
       * decoded length, encoded length ceil((n bytes * 8 bits/input byte) / 7 
bits/encoded byte) +
/home/zhangduo/hbase/code/hbase-common/src/test/java/org/apache/hadoop/hbase/Waiter.java:
   * The actual time out value will equal to hbase.test.wait.for.ratio * 
passed-in timeout
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Table.java:
   *          currently, but this may change in the future. An * {@link 
IllegalArgumentException}
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/Scan.java:
   *                  * @deprecated since 2.5.0, will be removed in 4.0.0. The 
name of this method
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/TableDescriptorBuilder.java:
     *         * @see #toByteArray()
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/client/AsyncTableResultScanner.java:
 * {@code 2 * scan.getMaxResultSize()}.
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/filter/FilterBase.java:
   * * @return true if and only if the fields of the filter that are serialized 
are equal to the
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlUtil.java:
   *                   * @deprecated Use {@link 
Admin#getUserPermissions(GetUserPermissionsRequest)}
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlUtil.java:
   *                        * @deprecated Use
/home/zhangduo/hbase/code/hbase-client/src/main/java/org/apache/hadoop/hbase/security/access/AccessControlUtil.java:
   *                   * @deprecated Use {@link 
Admin#getUserPermissions(GetUserPermissionsRequest)}
/home/zhangduo/hbase/code/hbase-testing-util/src/main/java/org/apache/hadoop/hbase/MiniHBaseCluster.java:
   * * @return Name of master that just went down.
/home/zhangduo/hbase/code/hbase-testing-util/src/main/java/org/apache/hadoop/hbase/HBaseTestingUtility.java:
   * * @return another region server
/home/zhangduo/hbase/code/hbase-mapreduce/src/main/java/org/apache/hadoop/hbase/mapreduce/TableInputFormatBase.java:
   * @return A list of TableSplit, the size of the list is * @throws 
IllegalArgumentIOException
/home/zhangduo/hbase/code/hbase-thrift/src/test/java/org/apache/hadoop/hbase/thrift2/TestThriftHBaseServiceHandlerWithLabels.java:
   * Padding numbers to make comparison of sort order easier in a for loop The 
number to pad. * *
/home/zhangduo/hbase/code/hbase-http/src/main/java/org/apache/hadoop/hbase/util/JSONMetricUtil.java:
   * @return Map or null if arrays are empty * or have different number of 
elements
{noformat}

> Clean up current broken 'n's in our javadoc
> -------------------------------------------
>
>                 Key: HBASE-27401
>                 URL: https://issues.apache.org/jira/browse/HBASE-27401
>             Project: HBase
>          Issue Type: Sub-task
>            Reporter: Duo Zhang
>            Assignee: Duo Zhang
>            Priority: Major
>         Attachments: ns_at_the_end, ns_in_the_middle
>
>




--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to