HCAT-559 Fix trivial build warnings in HCat trunk.
git-svn-id: https://svn.apache.org/repos/asf/incubator/hcatalog/trunk@1417146 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/CHANGES.txt b/CHANGES.txt
index a564b35..6602043 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -147,6 +147,8 @@
OPTIMIZATIONS
BUG FIXES
+ HCAT-559 Fix trivial build warnings in HCat trunk (mithunr via avandana)
+
HCAT-555 hcat script should look for hcatalog-core jar and add HCAT_PREFIX/conf as a config location that is checked. (arpitgupta via traviscrawford)
HCAT-534 HCat_Drop_Table_3 dfs mkdir failing on hadoop23 (cdrome via toffer)
diff --git a/build.xml b/build.xml
index 624f2cc..2fcb3ff 100644
--- a/build.xml
+++ b/build.xml
@@ -168,6 +168,7 @@
<target name="javadoc" depends="jar" description="Generate Javadoc documentation">
<mkdir dir="${build.javadoc}"/>
+ <record name="${build.dir}/javadoc.log" action="start"/>
<javadoc overview="${src.dir}/../docs/overview.html"
packagenames="org.apache.hcatalog.*"
destdir="${build.javadoc}"
@@ -194,6 +195,13 @@
</classpath>
<group title="hcatalog" packages="org.apache.hcatalog.*"/>
</javadoc>
+ <record name="${build.dir}/javadoc.log" action="stop"/>
+ <condition property="javadoc.warnings">
+ <isfileselected file="${build.dir}/javadoc.log">
+ <contains text="warnings"/>
+ </isfileselected>
+ </condition>
+ <fail if="javadoc.warnings">Javadoc comments contain warnings.</fail>
</target>
<!--
diff --git a/core/src/main/java/org/apache/hcatalog/common/HCatConstants.java b/core/src/main/java/org/apache/hcatalog/common/HCatConstants.java
index 1a9e6fc..50bade0 100644
--- a/core/src/main/java/org/apache/hcatalog/common/HCatConstants.java
+++ b/core/src/main/java/org/apache/hcatalog/common/HCatConstants.java
@@ -45,9 +45,9 @@
/**
* {@value} (default: null)
- * When the property is set in the UDFContext of the {@link HCatStorer}, {@link HCatStorer} writes
+ * When the property is set in the UDFContext of the org.apache.hcatalog.pig.HCatStorer, HCatStorer writes
* to the location it specifies instead of the default HCatalog location format. An example can be found
- * in @{link HCatStorerWrapper}.
+ * in org.apache.hcatalog.pig.HCatStorerWrapper.
*/
public static final String HCAT_PIG_STORER_EXTERNAL_LOCATION = HCAT_PIG_STORER + ".external.location";
diff --git a/core/src/main/java/org/apache/hcatalog/mapreduce/FileOutputFormatContainer.java b/core/src/main/java/org/apache/hcatalog/mapreduce/FileOutputFormatContainer.java
index 22d73da..bd7eed8 100644
--- a/core/src/main/java/org/apache/hcatalog/mapreduce/FileOutputFormatContainer.java
+++ b/core/src/main/java/org/apache/hcatalog/mapreduce/FileOutputFormatContainer.java
@@ -123,10 +123,10 @@
new Table(jobInfo.getTableInfo().getTable()));
} catch (MetaException e) {
throw new IOException(e);
- } catch (TException e) {
- throw new IOException(e);
} catch (NoSuchObjectException e) {
throw new IOException(e);
+ } catch (TException e) {
+ throw new IOException(e);
} finally {
HCatUtil.closeHiveClientQuietly(client);
}
diff --git a/core/src/main/java/org/apache/hcatalog/mapreduce/HCatOutputFormat.java b/core/src/main/java/org/apache/hcatalog/mapreduce/HCatOutputFormat.java
index 22293ab..96fa543 100644
--- a/core/src/main/java/org/apache/hcatalog/mapreduce/HCatOutputFormat.java
+++ b/core/src/main/java/org/apache/hcatalog/mapreduce/HCatOutputFormat.java
@@ -58,7 +58,7 @@
private static boolean harRequested;
/**
- * @see org.apache.hcatalog.mapreduce.HCatOutputFormat#setOutput(org.apache.hadoop.conf.Configuration, OutputJobInfo)
+ * @see org.apache.hcatalog.mapreduce.HCatOutputFormat#setOutput(org.apache.hadoop.conf.Configuration, Credentials, OutputJobInfo)
*/
public static void setOutput(Job job, OutputJobInfo outputJobInfo) throws IOException {
setOutput(job.getConfiguration(), job.getCredentials(), outputJobInfo);
@@ -68,7 +68,8 @@
* Set the information about the output to write for the job. This queries the metadata server
* to find the StorageHandler to use for the table. It throws an error if the
* partition is already published.
- * @param job the job object
+ * @param conf the Configuration object
+ * @param credentials the Credentials object
* @param outputJobInfo the table output information for the job
* @throws IOException the exception in communicating with the metadata server
*/
diff --git a/server-extensions/src/main/java/org/apache/hcatalog/listener/NotificationListener.java b/server-extensions/src/main/java/org/apache/hcatalog/listener/NotificationListener.java
index cd7530b..0e4ec30 100644
--- a/server-extensions/src/main/java/org/apache/hcatalog/listener/NotificationListener.java
+++ b/server-extensions/src/main/java/org/apache/hcatalog/listener/NotificationListener.java
@@ -315,8 +315,8 @@
* Get the topic object for the topicName, it also tries to reconnect
* if the connection appears to be broken.
*
- * @param topicName
- * @return
+ * @param topicName The String identifying the message-topic.
+ * @return A {@link Topic} object corresponding to the specified topicName.
* @throws JMSException
*/
protected Topic getTopic(final String topicName) throws JMSException {
diff --git a/webhcat/java-client/src/main/java/org/apache/hcatalog/api/HCatClient.java b/webhcat/java-client/src/main/java/org/apache/hcatalog/api/HCatClient.java
index d966b8b..157f66e 100644
--- a/webhcat/java-client/src/main/java/org/apache/hcatalog/api/HCatClient.java
+++ b/webhcat/java-client/src/main/java/org/apache/hcatalog/api/HCatClient.java
@@ -218,7 +218,7 @@
* Adds a list of partitions.
*
* @param partInfoList A list of HCatAddPartitionDesc.
- * @return
+ * @return The number of partitions added.
* @throws HCatException,ConnectionFailureException
*/
public abstract int addPartitions(List<HCatAddPartitionDesc> partInfoList)
