HBASE-27401 Addendum fix more javadoc issues

This commit is contained in:
Duo Zhang 2022-10-07 00:54:05 +08:00
parent 54a82302b4
commit 4b45256910
2 changed files with 24 additions and 12 deletions

View File

@ -1642,10 +1642,12 @@ public abstract class HFileReaderImpl implements HFile.Reader, Configurable {
/** /**
* Create a Scanner on this file. No seeks or reads are done on creation. Call * Create a Scanner on this file. No seeks or reads are done on creation. Call
* {@link HFileScanner#seekTo(Cell)} to position an start the read. There is nothing to clean up * {@link HFileScanner#seekTo(Cell)} to position an start the read. There is nothing to clean up
* in a Scanner. Letting go of your references to the scanner is sufficient. Store configuration. * in a Scanner. Letting go of your references to the scanner is sufficient.
* True if we should cache blocks read in by this scanner. Use positional read rather than * @param conf Store configuration.
* seek+read if true (pread is better for random reads, seek+read is better scanning). is scanner * @param cacheBlocks True if we should cache blocks read in by this scanner.
* being used for a compaction? * @param pread Use positional read rather than seek+read if true (pread is better for
* random reads, seek+read is better scanning).
* @param isCompaction is scanner being used for a compaction?
* @return Scanner on this file. * @return Scanner on this file.
*/ */
@Override @Override

View File

@ -51,8 +51,11 @@ public final class MobFileName {
public static final String REGION_SEP = "_"; public static final String REGION_SEP = "_";
/** /**
* The start key. The string of the latest timestamp of cells in this file, the format is * Creates an instance of MobFileName
* yyyymmdd. The uuid * @param startKey The start key.
* @param date The string of the latest timestamp of cells in this file, the format is
* yyyymmdd.
* @param uuid The uuid
* @param regionName name of a region, where this file was created during flush or compaction. * @param regionName name of a region, where this file was created during flush or compaction.
*/ */
private MobFileName(byte[] startKey, String date, String uuid, String regionName) { private MobFileName(byte[] startKey, String date, String uuid, String regionName) {
@ -64,8 +67,11 @@ public final class MobFileName {
} }
/** /**
* The md5 hex string of the start key. The string of the latest timestamp of cells in this file, * Creates an instance of MobFileName
* the format is yyyymmdd. The uuid * @param startKey The md5 hex string of the start key.
* @param date The string of the latest timestamp of cells in this file, the format is
* yyyymmdd.
* @param uuid The uuid
* @param regionName name of a region, where this file was created during flush or compaction. * @param regionName name of a region, where this file was created during flush or compaction.
*/ */
private MobFileName(String startKey, String date, String uuid, String regionName) { private MobFileName(String startKey, String date, String uuid, String regionName) {
@ -77,8 +83,10 @@ public final class MobFileName {
} }
/** /**
* Creates an instance of MobFileName The md5 hex string of the start key. The string of the * Creates an instance of MobFileName
* latest timestamp of cells in this file, the format is yyyymmdd. * @param startKey The md5 hex string of the start key.
* @param date The string of the latest timestamp of cells in this file, the format is
* yyyymmdd.
* @param uuid The uuid. * @param uuid The uuid.
* @param regionName name of a region, where this file was created during flush or compaction. * @param regionName name of a region, where this file was created during flush or compaction.
* @return An instance of a MobFileName. * @return An instance of a MobFileName.
@ -88,8 +96,10 @@ public final class MobFileName {
} }
/** /**
* Creates an instance of MobFileName The md5 hex string of the start key. The string of the * Creates an instance of MobFileName
* latest timestamp of cells in this file, the format is yyyymmdd. * @param startKey The md5 hex string of the start key.
* @param date The string of the latest timestamp of cells in this file, the format is
* yyyymmdd.
* @param uuid The uuid. * @param uuid The uuid.
* @param regionName name of a region, where this file was created during flush or compaction. * @param regionName name of a region, where this file was created during flush or compaction.
* @return An instance of a MobFileName. * @return An instance of a MobFileName.