Skip to content

HBASE-22586 Javadoc Warnings related to @param tag - #322

Merged
HorizonNet merged 3 commits into
apache:masterfrom
murtazahassan123:HBASE-22586
Jul 13, 2019
Merged

HBASE-22586 Javadoc Warnings related to @param tag#322
HorizonNet merged 3 commits into
apache:masterfrom
murtazahassan123:HBASE-22586

Conversation

@murtazahassan123

@murtazahassan123murtazahassan123 commented Jun 18, 2019

Copy link
Copy Markdown
Contributor

Fixed javadoc warnings related to @PARAM tag.

@HorizonNet

HorizonNet commented Jun 22, 2019

Copy link
Copy Markdown
Contributor

@SyedMurtazaHassan Could you please resolve the merge conflict?

@the-sakthi

the-sakthi commented Jun 27, 2019

Copy link
Copy Markdown
Member

@SyedMurtazaHassan any updates on this?

@murtazahassan123

murtazahassan123 commented Jun 28, 2019

Copy link
Copy Markdown
ContributorAuthor

@jatsakthi Resolved the merge conflict. Kindly review.

@Apache-HBase

Apache-HBase commented Jun 28, 2019

Copy link
Copy Markdown

🎊 +1 overall

VoteSubsystemRuntimeComment
0reexec29Docker mode activated.
_ Prechecks _
+1hbaseanti0Patch does not have any anti-patterns.
+1@author0The patch does not contain any @author tags.
+1test4tests0The patch appears to include 7 new or modified test files.
_ master Compile Tests _
0mvndep11Maven dependency ordering for branch
+1mvninstall230master passed
+1compile107master passed
+1checkstyle110master passed
+1shadedjars252branch has no errors when building our shaded downstream artifacts.
+1findbugs305master passed
+1javadoc80master passed
_ Patch Compile Tests _
0mvndep14Maven dependency ordering for patch
+1mvninstall237the patch passed
+1compile111the patch passed
+1javac111the patch passed
+1checkstyle23The patch passed checkstyle in hbase-common
+1checkstyle10The patch passed checkstyle in hbase-hadoop2-compat
+1checkstyle64hbase-server: The patch generated 0 new + 87 unchanged - 4 fixed = 87 total (was 91)
+1checkstyle16The patch passed checkstyle in hbase-mapreduce
+1whitespace0The patch has no whitespace issues.
+1shadedjars262patch has no errors when building our shaded downstream artifacts.
+1hadoopcheck717Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1findbugs343the patch passed
+1javadoc87the patch passed
_ Other Tests _
+1unit189hbase-common in the patch passed.
+1unit34hbase-hadoop2-compat in the patch passed.
+1unit7950hbase-server in the patch passed.
+1unit1063hbase-mapreduce in the patch passed.
+1asflicense78The patch does not generate ASF License warnings.
12681
SubsystemReport/Notes
DockerClient=17.05.0-ce Server=17.05.0-ce base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/1/artifact/out/Dockerfile
GITHUB PR#322
Optional Testsdupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
unameLinux f4a38da3d394 4.4.0-138-generic #164-Ubuntu SMP Tue Oct 2 17:16:02 UTC 2018 x86_64 GNU/Linux
Build toolmaven
Personality/testptch/patchprocess/precommit/personality/provided.sh
git revisionmaster / 0c8dc5d
mavenversion: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java1.8.0_181
findbugsv3.1.11
Test Resultshttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/1/testReport/
Max. process+thread count5462 (vs. ulimit of 10000)
modulesC: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console outputhttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/1/console
Powered byApache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

HorizonNet
HorizonNet requested changes Jun 28, 2019
View reviewed changes

@HorizonNetHorizonNet left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few comments for improvements.

Comment threadhbase-server/src/main/java/org/apache/hadoop/hbase/HealthChecker.java Outdated
Comment threadhbase-server/src/main/java/org/apache/hadoop/hbase/HealthChecker.java Outdated
Comment threadhbase-server/src/main/java/org/apache/hadoop/hbase/namespace/NamespaceStateManager.java Outdated
Comment threadhbase-server/src/main/java/org/apache/hadoop/hbase/replication/regionserver/WALEntryStream.java Outdated
Comment threadhbase-server/src/test/java/org/apache/hadoop/hbase/master/TestActiveMasterManager.java Outdated
Comment threadhbase-server/src/test/java/org/apache/hadoop/hbase/util/ProcessBasedLocalHBaseCluster.java Outdated
Comment threadhbase-server/src/test/java/org/apache/hadoop/hbase/regionserver/EncodedSeekPerformanceTest.java Outdated
Comment threadhbase-server/src/test/java/org/apache/hadoop/hbase/procedure/TestZKProcedure.java Outdated
Comment threadhbase-server/src/test/java/org/apache/hadoop/hbase/procedure/TestZKProcedure.java Outdated
Comment threadhbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java Outdated
@murtazahassan123

murtazahassan123 commented Jul 1, 2019

Copy link
Copy Markdown
ContributorAuthor

improvements

@HorizonNet Thank you. Addressed your comments. Kindly have a look.

@Apache-HBase

Apache-HBase commented Jul 1, 2019

Copy link
Copy Markdown

💔 -1 overall

VoteSubsystemRuntimeComment
0reexec165Docker mode activated.
_ Prechecks _
+1hbaseanti0Patch does not have any anti-patterns.
+1@author0The patch does not contain any @author tags.
+1test4tests0The patch appears to include 7 new or modified test files.
_ master Compile Tests _
0mvndep20Maven dependency ordering for branch
+1mvninstall249master passed
+1compile117master passed
+1checkstyle126master passed
+1shadedjars269branch has no errors when building our shaded downstream artifacts.
+1findbugs315master passed
+1javadoc84master passed
_ Patch Compile Tests _
0mvndep16Maven dependency ordering for patch
+1mvninstall239the patch passed
+1compile117the patch passed
+1javac117the patch passed
+1checkstyle25The patch passed checkstyle in hbase-common
+1checkstyle12The patch passed checkstyle in hbase-hadoop2-compat
+1checkstyle69hbase-server: The patch generated 0 new + 84 unchanged - 7 fixed = 84 total (was 91)
+1checkstyle16The patch passed checkstyle in hbase-mapreduce
+1whitespace0The patch has no whitespace issues.
+1shadedjars267patch has no errors when building our shaded downstream artifacts.
+1hadoopcheck704Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1findbugs349the patch passed
+1javadoc83the patch passed
_ Other Tests _
+1unit181hbase-common in the patch passed.
+1unit35hbase-hadoop2-compat in the patch passed.
-1unit16627hbase-server in the patch failed.
-1unit1539hbase-mapreduce in the patch failed.
+1asflicense96The patch does not generate ASF License warnings.
22062
ReasonTests
Failed junit testshadoop.hbase.master.procedure.TestSCPWithReplicas
hadoop.hbase.client.TestSnapshotTemporaryDirectory
hadoop.hbase.client.TestSnapshotDFSTemporaryDirectory
hadoop.hbase.client.TestAsyncSnapshotAdminApi
hadoop.hbase.snapshot.TestExportSnapshotNoCluster
SubsystemReport/Notes
DockerClient=17.05.0-ce Server=17.05.0-ce base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/artifact/out/Dockerfile
GITHUB PR#322
Optional Testsdupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
unameLinux 458c23988b59 4.4.0-138-generic #164-Ubuntu SMP Tue Oct 2 17:16:02 UTC 2018 x86_64 GNU/Linux
Build toolmaven
Personality/testptch/patchprocess/precommit/personality/provided.sh
git revisionmaster / 0c8dc5d
mavenversion: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java1.8.0_181
findbugsv3.1.11
unithttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/artifact/out/patch-unit-hbase-server.txt
unithttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/artifact/out/patch-unit-hbase-mapreduce.txt
Test Resultshttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/testReport/
Max. process+thread count5305 (vs. ulimit of 10000)
modulesC: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console outputhttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/2/console
Powered byApache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

@saintstack

saintstack commented Jul 1, 2019

Copy link
Copy Markdown
Contributor

Re-running build.

@Apache-HBase

Apache-HBase commented Jul 2, 2019

Copy link
Copy Markdown

💔 -1 overall

VoteSubsystemRuntimeComment
0reexec51Docker mode activated.
_ Prechecks _
+1hbaseanti0Patch does not have any anti-patterns.
+1@author0The patch does not contain any @author tags.
+1test4tests0The patch appears to include 7 new or modified test files.
_ master Compile Tests _
0mvndep18Maven dependency ordering for branch
+1mvninstall274master passed
+1compile121master passed
+1checkstyle128master passed
+1shadedjars276branch has no errors when building our shaded downstream artifacts.
+1findbugs320master passed
+1javadoc86master passed
_ Patch Compile Tests _
0mvndep15Maven dependency ordering for patch
+1mvninstall240the patch passed
+1compile119the patch passed
+1javac119the patch passed
+1checkstyle24The patch passed checkstyle in hbase-common
+1checkstyle12The patch passed checkstyle in hbase-hadoop2-compat
+1checkstyle72hbase-server: The patch generated 0 new + 84 unchanged - 7 fixed = 84 total (was 91)
+1checkstyle17The patch passed checkstyle in hbase-mapreduce
+1whitespace0The patch has no whitespace issues.
+1shadedjars264patch has no errors when building our shaded downstream artifacts.
+1hadoopcheck742Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1findbugs341the patch passed
+1javadoc84the patch passed
_ Other Tests _
+1unit174hbase-common in the patch passed.
+1unit43hbase-hadoop2-compat in the patch passed.
-1unit16057hbase-server in the patch failed.
-1unit1587hbase-mapreduce in the patch failed.
+1asflicense133The patch does not generate ASF License warnings.
21568
ReasonTests
Failed junit testshadoop.hbase.client.TestFromClientSideWithCoprocessor
hadoop.hbase.master.TestMasterShutdown
hadoop.hbase.snapshot.TestExportSnapshotNoCluster
SubsystemReport/Notes
DockerClient=17.05.0-ce Server=17.05.0-ce base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/artifact/out/Dockerfile
GITHUB PR#322
Optional Testsdupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
unameLinux a6a0f5a14afd 4.4.0-138-generic #164-Ubuntu SMP Tue Oct 2 17:16:02 UTC 2018 x86_64 GNU/Linux
Build toolmaven
Personality/testptch/patchprocess/precommit/personality/provided.sh
git revisionmaster / 52eb893
mavenversion: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java1.8.0_181
findbugsv3.1.11
unithttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/artifact/out/patch-unit-hbase-server.txt
unithttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/artifact/out/patch-unit-hbase-mapreduce.txt
Test Resultshttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/testReport/
Max. process+thread count5447 (vs. ulimit of 10000)
modulesC: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console outputhttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/3/console
Powered byApache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

the-sakthi
the-sakthi reviewed Jul 3, 2019
View reviewed changes

@the-sakthithe-sakthi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The addition of class links in the params is not consistent in few places. For e.g. CellComparator's link is added in compareWithoutRow() but not in compare(). Can we fix all such cases?

@murtazahassan123

murtazahassan123 commented Jul 4, 2019

Copy link
Copy Markdown
ContributorAuthor

@jatsakthi
Should i fix all such cases as a part of this ticket?
Because in this ticket i added javadoc for compareWithoutRow() and didnt touch compare() so i didnt know CellComparator's link is not there.

HorizonNet
HorizonNet reviewed Jul 4, 2019
View reviewed changes
Comment threadhbase-common/src/main/java/org/apache/hadoop/hbase/PrivateCellUtil.java
Comment threadhbase-common/src/test/java/org/apache/hadoop/hbase/util/ClassLoaderTestHelper.java
Comment threadhbase-server/src/test/java/org/apache/hadoop/hbase/master/TestActiveMasterManager.java Outdated
* @throws IOException
* @param zk single zookeeper watcher
* @param expectedAddress the expected address of the master
* @throws KeeperException unexpected zookeeper exception

@HorizonNetHorizonNetJul 4, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"ZooKeeper"

@HorizonNet

HorizonNet commented Jul 4, 2019

Copy link
Copy Markdown
Contributor

@SyedMurtazaHassan My suggestion is, if you need to touch the class due to param changes, you can do it in this PR.

@murtazahassan123

murtazahassan123 commented Jul 4, 2019

Copy link
Copy Markdown
ContributorAuthor

@HorizonNet
Thanks for valuable comments. I will address them and make the fixes accordingly..

@murtazahassan123

murtazahassan123 commented Jul 8, 2019

Copy link
Copy Markdown
ContributorAuthor

@jatsakthi @HorizonNet Adressed the comments. Kindly have a look when you have time.
Thanks.

@Apache-HBase

Apache-HBase commented Jul 8, 2019

Copy link
Copy Markdown

💔 -1 overall

VoteSubsystemRuntimeComment
0reexec179Docker mode activated.
_ Prechecks _
+1hbaseanti0Patch does not have any anti-patterns.
+1@author0The patch does not contain any @author tags.
+1test4tests0The patch appears to include 7 new or modified test files.
_ master Compile Tests _
0mvndep24Maven dependency ordering for branch
+1mvninstall260master passed
+1compile114master passed
+1checkstyle117master passed
+1shadedjars271branch has no errors when building our shaded downstream artifacts.
+1findbugs320master passed
+1javadoc82master passed
_ Patch Compile Tests _
0mvndep14Maven dependency ordering for patch
+1mvninstall241the patch passed
+1compile113the patch passed
+1javac113the patch passed
+1checkstyle21hbase-common: The patch generated 0 new + 63 unchanged - 8 fixed = 63 total (was 71)
+1checkstyle10The patch passed checkstyle in hbase-hadoop2-compat
+1checkstyle63hbase-server: The patch generated 0 new + 84 unchanged - 7 fixed = 84 total (was 91)
+1checkstyle16The patch passed checkstyle in hbase-mapreduce
+1whitespace0The patch has no whitespace issues.
+1shadedjars261patch has no errors when building our shaded downstream artifacts.
+1hadoopcheck760Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1findbugs344the patch passed
+1javadoc79the patch passed
_ Other Tests _
+1unit172hbase-common in the patch passed.
+1unit36hbase-hadoop2-compat in the patch passed.
-1unit14981hbase-server in the patch failed.
+1unit1360hbase-mapreduce in the patch passed.
+1asflicense108The patch does not generate ASF License warnings.
20304
SubsystemReport/Notes
DockerClient=17.05.0-ce Server=17.05.0-ce base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/4/artifact/out/Dockerfile
GITHUB PR#322
Optional Testsdupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
unameLinux b1781cd27745 4.4.0-137-generic #163-Ubuntu SMP Mon Sep 24 13:14:43 UTC 2018 x86_64 GNU/Linux
Build toolmaven
Personality/testptch/patchprocess/precommit/personality/provided.sh
git revisionmaster / 605f8a1
mavenversion: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java1.8.0_181
findbugsv3.1.11
unithttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/4/artifact/out/patch-unit-hbase-server.txt
Test Resultshttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/4/testReport/
Max. process+thread count5278 (vs. ulimit of 10000)
modulesC: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console outputhttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/4/console
Powered byApache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

@the-sakthi

the-sakthi commented Jul 11, 2019

Copy link
Copy Markdown
Member

LGTM

@Apache-HBase

Apache-HBase commented Jul 13, 2019

Copy link
Copy Markdown

💔 -1 overall

VoteSubsystemRuntimeComment
0reexec88Docker mode activated.
_ Prechecks _
+1hbaseanti0Patch does not have any anti-patterns.
+1@author0The patch does not contain any @author tags.
+1test4tests0The patch appears to include 7 new or modified test files.
_ master Compile Tests _
0mvndep15Maven dependency ordering for branch
+1mvninstall270master passed
+1compile123master passed
+1checkstyle141master passed
+1shadedjars303branch has no errors when building our shaded downstream artifacts.
+1findbugs387master passed
+1javadoc89master passed
_ Patch Compile Tests _
0mvndep14Maven dependency ordering for patch
+1mvninstall275the patch passed
+1compile129the patch passed
+1javac129the patch passed
+1checkstyle28hbase-common: The patch generated 0 new + 63 unchanged - 8 fixed = 63 total (was 71)
+1checkstyle12The patch passed checkstyle in hbase-hadoop2-compat
+1checkstyle83hbase-server: The patch generated 0 new + 84 unchanged - 7 fixed = 84 total (was 91)
+1checkstyle19The patch passed checkstyle in hbase-mapreduce
+1whitespace0The patch has no whitespace issues.
+1shadedjars303patch has no errors when building our shaded downstream artifacts.
+1hadoopcheck847Patch does not cause any errors with Hadoop 2.8.5 2.9.2 or 3.1.2.
+1findbugs413the patch passed
+1javadoc93the patch passed
_ Other Tests _
+1unit182hbase-common in the patch passed.
+1unit35hbase-hadoop2-compat in the patch passed.
-1unit15663hbase-server in the patch failed.
+1unit1726hbase-mapreduce in the patch passed.
+1asflicense147The patch does not generate ASF License warnings.
21776
SubsystemReport/Notes
DockerClient=18.09.7 Server=18.09.7 base: https://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/5/artifact/out/Dockerfile
GITHUB PR#322
Optional Testsdupname asflicense javac javadoc unit findbugs shadedjars hadoopcheck hbaseanti checkstyle compile
unameLinux 14577bb991f8 4.15.0-52-generic #56-Ubuntu SMP Tue Jun 4 22:49:08 UTC 2019 x86_64 GNU/Linux
Build toolmaven
Personality/testptch/patchprocess/precommit/personality/provided.sh
git revisionmaster / 438bf32
mavenversion: Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T18:33:14Z)
Default Java1.8.0_181
findbugsv3.1.11
unithttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/5/artifact/out/patch-unit-hbase-server.txt
Test Resultshttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/5/testReport/
Max. process+thread count5437 (vs. ulimit of 10000)
modulesC: hbase-common hbase-hadoop2-compat hbase-server hbase-mapreduce U: .
Console outputhttps://builds.apache.org/job/HBase-PreCommit-GitHub-PR/job/PR-322/5/console
Powered byApache Yetus 0.9.0 http://yetus.apache.org

This message was automatically generated.

@HorizonNet
HorizonNet merged commit 8defea9 into apache:masterJul 13, 2019
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@HorizonNetHorizonNetHorizonNet approved these changes
+1 more reviewer
@the-sakthithe-sakthithe-sakthi approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@murtazahassan123@HorizonNet@the-sakthi@Apache-HBase@saintstack