HTRACE-370. htrace-hbase: fix jdk8 javadoc build error (Nisala Mendis via cmccabe)
diff --git a/htrace-hbase/pom.xml b/htrace-hbase/pom.xml
index 81b8803..8af516c 100644
--- a/htrace-hbase/pom.xml
+++ b/htrace-hbase/pom.xml
@@ -102,6 +102,9 @@
</plugin>
<plugin>
<artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <excludePackageNames>org.apache.htrace.protobuf.generated</excludePackageNames>
+ </configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -239,12 +242,5 @@
</plugins>
</build>
</profile>
- <profile>
- <id>doclint-disable</id>
- <activation><jdk>[1.8,)</jdk></activation>
- <properties>
- <additionalparam>-Xdoclint:none</additionalparam>
- </properties>
- </profile>
</profiles>
</project>
diff --git a/htrace-hbase/src/main/java/org/apache/htrace/impl/HBaseSpanReceiver.java b/htrace-hbase/src/main/java/org/apache/htrace/impl/HBaseSpanReceiver.java
index f2537f9..52e2fa8 100644
--- a/htrace-hbase/src/main/java/org/apache/htrace/impl/HBaseSpanReceiver.java
+++ b/htrace-hbase/src/main/java/org/apache/htrace/impl/HBaseSpanReceiver.java
@@ -101,9 +101,9 @@
/**
* The thread factory used to create new ExecutorService.
- * <p/>
- * This will be the same factory for the lifetime of this object so that
- * no thread names will ever be duplicated.
+ *
+ * <p>This will be the same factory for the lifetime of this object so that
+ * no thread names will ever be duplicated.</p>
*/
private final ThreadFactory tf = new ThreadFactory() {
private final AtomicLong receiverIdx = new AtomicLong(0);
@@ -301,10 +301,10 @@
/**
* Close the receiver.
- * <p/>
- * This tries to shutdown thread pool.
*
- * @throws IOException
+ * <p>This tries to shutdown thread pool.</p>
+ *
+ * @throws IOException If a I/O Stream related error occurs and exception is thrown.
*/
@Override
public void close() throws IOException {
@@ -339,7 +339,9 @@
* Run basic test. Adds span to an existing htrace table in an existing hbase setup.
* Requires a running hbase to send the traces too with an already created trace
* table (Default table name is 'htrace' with column families 's' and 'i').
- * @throws IOException
+ *
+ * @param args Default arguments which passed to main method
+ * @throws InterruptedException Thread.sleep() can cause interruption in current thread.
*/
public static void main(String[] args) throws Exception {
Tracer tracer = new Tracer.Builder().
diff --git a/htrace-hbase/src/main/java/org/apache/htrace/viewer/HBaseSpanViewer.java b/htrace-hbase/src/main/java/org/apache/htrace/viewer/HBaseSpanViewer.java
index 114ab4f..91b322c 100644
--- a/htrace-hbase/src/main/java/org/apache/htrace/viewer/HBaseSpanViewer.java
+++ b/htrace-hbase/src/main/java/org/apache/htrace/viewer/HBaseSpanViewer.java
@@ -205,8 +205,10 @@
}
/**
- * Run basic test.
- * @throws IOException
+ * Run basic test for retrieving spans from Stored Format.
+ *
+ * @param args Default Arguments which passed to main method
+ * @throws IOException is thrown if error occur while Spans are De-serialized from byte Streams
*/
public static void main(String[] args) throws IOException {
HBaseSpanViewer viewer = new HBaseSpanViewer(HBaseConfiguration.create());
diff --git a/htrace-hbase/src/main/java/org/apache/htrace/viewer/HBaseSpanViewerServer.java b/htrace-hbase/src/main/java/org/apache/htrace/viewer/HBaseSpanViewerServer.java
index 1ae7165..54390ba 100644
--- a/htrace-hbase/src/main/java/org/apache/htrace/viewer/HBaseSpanViewerServer.java
+++ b/htrace-hbase/src/main/java/org/apache/htrace/viewer/HBaseSpanViewerServer.java
@@ -86,7 +86,10 @@
}
/**
- * @throws IOException
+ * Runs Embedded Jetty server which exposes traces and spans Servlets exposed over HTTP protocol.
+ *
+ * @param args Default Arguments which passed to main method
+ * @throws Exception Which are propagated from Embedded Jetty Server to Hadoop tool runner.
*/
public static void main(String[] args) throws Exception {
ToolRunner.run(HBaseConfiguration.create(), new HBaseSpanViewerServer(), args);
