Uploaded image for project: 'HBase'
  1. HBase
  2. HBASE-9688

Fix javadoc warning in HConnectionManager class javadoc

    XMLWordPrintableJSON

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 0.98.0, 0.96.0
    • Component/s: None
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      Description

      From https://builds.apache.org/job/PreCommit-HBASE-Build/7422/artifact/trunk/patchprocess/patchJavadocWarnings.txt :

      [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
      

      The @code misses right brace

        Attachments

        1. 9688.patch
          0.7 kB
          Ted Yu

          Activity

            People

            • Assignee:
              yuzhihong@gmail.com Ted Yu
              Reporter:
              yuzhihong@gmail.com Ted Yu
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: