[
https://issues.apache.org/jira/browse/HADOOP-18156?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17615346#comment-17615346
]
ASF GitHub Bot commented on HADOOP-18156:
-----------------------------------------
mukund-thakur commented on code in PR #4965:
URL: https://github.com/apache/hadoop/pull/4965#discussion_r991633470
##########
hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:
##########
@@ -960,43 +960,64 @@ public static final class ScanArgsBuilder {
/** Consider only markers in nonauth paths as errors. */
private boolean nonAuth = false;
- /** Source FS; must be or wrap an S3A FS. */
+ /** Source FS; must be or wrap an S3A FS.
Review Comment:
Well, when there is a single line comment we don't need a new line but a new
line is required when there are multiple lines comments as explained in the
check style rule sent by Danny. This is based on my observation in the Apache
Hadoop codebase.
Although I think the current changes should be okay, will confirm with
@steveloughran once and commit.
Sorry for not being clear before.
> Address JavaDoc warnings in classes like MarkerTool, S3ObjectAttributes, etc.
> -----------------------------------------------------------------------------
>
> Key: HADOOP-18156
> URL: https://issues.apache.org/jira/browse/HADOOP-18156
> Project: Hadoop Common
> Issue Type: Sub-task
> Components: fs/s3
> Affects Versions: 3.3.2
> Reporter: Mukund Thakur
> Assignee: Ankit Saurabh
> Priority: Minor
> Labels: pull-request-available
>
> {noformat}
> home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:856:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:150:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:964:
> warning: no @param for source
> [ERROR] public ScanArgsBuilder withSourceFS(final FileSystem source) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:964:
> warning: no @return
> [ERROR] public ScanArgsBuilder withSourceFS(final FileSystem source) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:970:
> warning: no @param for p
> [ERROR] public ScanArgsBuilder withPath(final Path p) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:970:
> warning: no @return
> [ERROR] public ScanArgsBuilder withPath(final Path p) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:976:
> warning: no @param for d
> [ERROR] public ScanArgsBuilder withDoPurge(final boolean d) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:976:
> warning: no @return
> [ERROR] public ScanArgsBuilder withDoPurge(final boolean d) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:982:
> warning: no @param for min
> [ERROR] public ScanArgsBuilder withMinMarkerCount(final int min) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:982:
> warning: no @return
> [ERROR] public ScanArgsBuilder withMinMarkerCount(final int min) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:988:
> warning: no @param for max
> [ERROR] public ScanArgsBuilder withMaxMarkerCount(final int max) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:988:
> warning: no @return
> [ERROR] public ScanArgsBuilder withMaxMarkerCount(final int max) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:994:
> warning: no @param for l
> [ERROR] public ScanArgsBuilder withLimit(final int l) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:994:
> warning: no @return
> [ERROR] public ScanArgsBuilder withLimit(final int l) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:1000:
> warning: no @param for b
> [ERROR] public ScanArgsBuilder withNonAuth(final boolean b) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:1000:
> warning: no @return
> [ERROR] public ScanArgsBuilder withNonAuth(final boolean b) {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:479:
> warning: no @return
> [ERROR] public int getExitCode() {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:484:
> warning: no @return
> [ERROR] public DirMarkerTracker getTracker() {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/tools/MarkerTool.java:489:
> warning: no @return
> [ERROR] public MarkerPurgeSummary getPurgeSummary() {
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3ObjectAttributes.java:69:
> warning: no description for @param
> [ERROR] * @param path
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/S3ObjectAttributes.java:73:
> warning: no description for @param
> [ERROR] * @param len
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/s3guard/S3GuardTool.java:84:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirectoryPolicy.java:86:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirectoryPolicy.java:72:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirectoryPolicy.java:79:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirMarkerTracker.java:131:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirMarkerTracker.java:226:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirMarkerTracker.java:37:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirMarkerTracker.java:41:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirMarkerTracker.java:45:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirMarkerTracker.java:50:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/DirMarkerTracker.java:109:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/OperationCallbacks.java:129:
> warning: no @param for destKey
> [ERROR] CopyResult copyFile(String srcKey,
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/RenameOperation.java:56:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/RenameOperation.java:60:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/RenameOperation.java:65:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/RenameOperation.java:74:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> /home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/src/main/java/org/apache/hadoop/fs/s3a/impl/RenameOperation.java:77:
> warning: empty <p> tag
> [ERROR] * <p></p>
> [ERROR] ^
> [ERROR]
> [ERROR] Command line was:
> /usr/lib/jvm/java-8-openjdk-amd64/jre/../bin/javadoc @options @packages
> [ERROR]
> [ERROR] Refer to the generated Javadoc files in
> '/home/jenkins/jenkins-home/workspace/hadoop-multibranch_PR-4045@2/ubuntu-focal/src/hadoop-tools/hadoop-aws/target/site/apidocs'
> dir.
> [ERROR] -> [Help 1]
> [ERROR]
> [ERROR] To see the full stack trace of the errors, re-run Maven with the -e
> switch.
> [ERROR] Re-run Maven using the -X switch to enable full debug logging.
> [ERROR]
> [ERROR] For more information about the errors and possible solutions, please
> read the following articles:
> [ERROR] [Help 1]
> http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException{noformat}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
