[jira] [Commented] (HBASE-12024) Fix javadoc warning

["Hadoop QA (JIRA)" <ji...@apache.org>]

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

Hadoop QA commented on HBASE-12024:
-----------------------------------

{color:red}-1 overall{color}.  Here are the results of testing the latest attachment 
  http://issues.apache.org/jira/secure/attachment/12669885/HBASE-12024-v0.patch
  against trunk revision .
  ATTACHMENT ID: 12669885

    {color:green}+1 @author{color}.  The patch does not contain any @author tags.

    {color:green}+0 tests included{color}.  The patch appears to be a documentation patch that doesn't require tests.

    {color:green}+1 javac{color}.  The applied patch does not increase the total number of javac compiler warnings.

    {color:green}+1 javac{color}.  The applied patch does not increase the total number of javac compiler warnings.

    {color:green}+1 javadoc{color}.  The javadoc tool did not generate any warning messages.

    {color:green}+1 findbugs{color}.  The patch does not introduce any new Findbugs (version 2.0.3) warnings.

    {color:green}+1 release audit{color}.  The applied patch does not increase the total number of release audit warnings.

    {color:green}+1 lineLengths{color}.  The patch does not introduce lines longer than 100

  {color:green}+1 site{color}.  The mvn site goal succeeds with this patch.

     {color:red}-1 core tests{color}.  The patch failed these unit tests:
                       org.apache.hadoop.hbase.util.TestProcessBasedCluster
                  org.apache.hadoop.hbase.mapreduce.TestImportExport

Test results: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//testReport/
Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//artifact/patchprocess/newPatchFindbugsWarningshbase-protocol.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop-compat.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//artifact/patchprocess/newPatchFindbugsWarningshbase-thrift.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//artifact/patchprocess/newPatchFindbugsWarningshbase-server.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//artifact/patchprocess/newPatchFindbugsWarningshbase-common.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//artifact/patchprocess/newPatchFindbugsWarningshbase-hadoop2-compat.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//artifact/patchprocess/newPatchFindbugsWarningshbase-examples.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//artifact/patchprocess/newPatchFindbugsWarningshbase-client.html
Findbugs warnings: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//artifact/patchprocess/newPatchFindbugsWarningshbase-prefix-tree.html
Console output: https://builds.apache.org/job/PreCommit-HBASE-Build/10984//console

This message is automatically generated.

> Fix javadoc warning
> -------------------
>
>                 Key: HBASE-12024
>                 URL: https://issues.apache.org/jira/browse/HBASE-12024
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 2.0.0
>            Reporter: Matteo Bertozzi
>            Assignee: Matteo Bertozzi
>            Priority: Trivial
>             Fix For: 2.0.0
>
>         Attachments: HBASE-12024-v0.patch
>
>
> There are a couple of javadoc warning
> {noformat}
> [WARNING] /home/th30z/asf/hbase/hbase-common/src/main/java/org/apache/hadoop/hbase/security/User.java:175: warning - @return tag has no arguments.
> [WARNING] Javadoc Warnings
> [WARNING] /home/th30z/asf/hbase/hbase-client/src/main/java/org/apache/hadoop/hbase/client/ConnectionFactory.java:56: warning - End Delimiter } missing for possible See Tag in comment string: "A non-instantiable class that manages creation of {@link Connection}s.
> [WARNING] Managing the lifecycle of the {@link Connection}s to the cluster is the responsibility of
> [WARNING] the caller.
> [WARNING] From this {@link Connection} {@link Table} implementations are retrieved
> [WARNING] with {@link Connection#getTable(TableName)}. Example:
> [WARNING] <pre>
> [WARNING] {@code
> [WARNING] Connection connection = ConnectionFactory.createConnection(config);
> [WARNING] Table table = connection.getTable(TableName.valueOf("table1"));
> [WARNING] try {
> [WARNING] // Use the table as needed, for a single operation and a single thread
> [WARNING] } finally {
> [WARNING] table.close();
> [WARNING] connection.close();
> [WARNING] }
> [WARNING] </pre>
> [WARNING] 
> [WARNING] Similarly, {@link Connection} also returns {@link RegionLocator} implementations.
> [WARNING] This class replaces {@link HConnectionManager}, which is now deprecated."
> [WARNING] /home/th30z/asf/hbase/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HConnectionManager.java:144: warning - End Delimiter } missing for possible See Tag in comment string: "Create a new HConnection instance using the passed <code>conf</code> instance.
> [WARNING] <p>Note: This bypasses the usual HConnection life cycle management done by
> [WARNING] {@link #getConnection(Configuration)}. The caller is responsible for
> [WARNING] calling {@link HConnection#close()} on the returned connection instance.
> [WARNING] This is the recommended way to create HConnections.
> [WARNING] {@code
> [WARNING] HConnection connection = HConnectionManager.createConnection(conf);
> [WARNING] HTableInterface table = connection.getTable("mytable");
> [WARNING] try {
> [WARNING] table.get(...);
> [WARNING] ...
> [WARNING] } finally {
> [WARNING] table.close();
> [WARNING] connection.close();
> [WARNING] }"
> {noformat}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)