Return-Path: X-Original-To: apmail-hbase-issues-archive@www.apache.org Delivered-To: apmail-hbase-issues-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 7257A1158E for ; Fri, 19 Sep 2014 01:38:35 +0000 (UTC) Received: (qmail 1708 invoked by uid 500); 19 Sep 2014 01:38:34 -0000 Delivered-To: apmail-hbase-issues-archive@hbase.apache.org Received: (qmail 1603 invoked by uid 500); 19 Sep 2014 01:38:34 -0000 Mailing-List: contact issues-help@hbase.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Delivered-To: mailing list issues@hbase.apache.org Received: (qmail 1355 invoked by uid 99); 19 Sep 2014 01:38:34 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 19 Sep 2014 01:38:34 +0000 Date: Fri, 19 Sep 2014 01:38:34 +0000 (UTC) From: "Matteo Bertozzi (JIRA)" To: issues@hbase.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Created] (HBASE-12024) Fix javadoc warning MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 Matteo Bertozzi created HBASE-12024: --------------------------------------- Summary: 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 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] 
[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]
[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 conf instance. [WARNING]

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)