hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ted Yu (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (HBASE-9688) Fix javadoc warning in HConnectionManager class javadoc
Date Sat, 05 Oct 2013 00:24:42 GMT

     [ https://issues.apache.org/jira/browse/HBASE-9688?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Ted Yu updated HBASE-9688:
--------------------------

    Fix Version/s: 0.96.0
                   0.98.0

> Fix javadoc warning in HConnectionManager class javadoc
> -------------------------------------------------------
>
>                 Key: HBASE-9688
>                 URL: https://issues.apache.org/jira/browse/HBASE-9688
>             Project: HBase
>          Issue Type: Bug
>            Reporter: Ted Yu
>            Assignee: Ted Yu
>            Priority: Minor
>             Fix For: 0.98.0, 0.96.0
>
>         Attachments: 9688.patch
>
>
> From https://builds.apache.org/job/PreCommit-HBASE-Build/7422/artifact/trunk/patchprocess/patchJavadocWarnings.txt
:
> {code}
> [WARNING] Javadoc Warnings
> [WARNING] /home/jenkins/jenkins-slave/workspace/PreCommit-HBASE-Build/trunk/hbase-client/src/main/java/org/apache/hadoop/hbase/client/HConnectionManager.java:193:
warning - End Delimiter } missing for possible See Tag in comment string: "A non-instantiable
class that manages creation of {@link HConnection}s.
> [WARNING] <p>The simplest way to use this class is by using {@link #createConnection(Configuration)}.
> [WARNING] This creates a new {@link HConnection} to the cluster that is managed by the
caller.
> [WARNING] From this {@link HConnection} {@link HTableInterface} implementations are retrieved
> [WARNING] with {@link HConnection#getTable(byte[])}. Example:
> [WARNING] <pre>
> [WARNING] {@code
> [WARNING] HConnection connection = HConnectionManager.createConnection(config);
> [WARNING] HTableInterface table = connection.getTable("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] <p>The following logic and API will be removed in the future:
> [WARNING] <p>This class has a static Map of {@link HConnection} instances keyed
by
> {code}
> The @code misses right brace



--
This message was sent by Atlassian JIRA
(v6.1#6144)

Mime
View raw message