chukwa-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ey...@apache.org
Subject [1/2] chukwa git commit: CHUKWA-794. Update Javadoc to support JDK 1.8. (Eric Yang)
Date Mon, 21 Dec 2015 18:05:28 GMT
Repository: chukwa
Updated Branches:
  refs/heads/chukwa-0.7 83baac244 -> ba16764a6


CHUKWA-794. Update Javadoc to support JDK 1.8. (Eric Yang)


Project: http://git-wip-us.apache.org/repos/asf/chukwa/repo
Commit: http://git-wip-us.apache.org/repos/asf/chukwa/commit/71cf0698
Tree: http://git-wip-us.apache.org/repos/asf/chukwa/tree/71cf0698
Diff: http://git-wip-us.apache.org/repos/asf/chukwa/diff/71cf0698

Branch: refs/heads/chukwa-0.7
Commit: 71cf0698bf01e53494dfea2071f553d49f293324
Parents: 83baac2
Author: Eric Yang <eyang@apache.org>
Authored: Sun Dec 13 14:26:57 2015 -0800
Committer: Eric Yang <eyang@apache.org>
Committed: Sun Dec 13 14:26:57 2015 -0800

----------------------------------------------------------------------
 CHANGES.txt                                     |  4 ++-
 pom.xml                                         | 30 ++++++++++++++--
 .../java/org/apache/hadoop/chukwa/Chunk.java    |  2 ++
 .../analysis/salsa/visualization/Heatmap.java   | 11 +++++-
 .../analysis/salsa/visualization/Swimlanes.java | 10 +++++-
 .../chukwa/datacollection/ChunkQueue.java       |  4 +++
 .../chukwa/datacollection/DataFactory.java      |  2 ++
 .../datacollection/OffsetStatsManager.java      |  1 +
 .../chukwa/datacollection/adaptor/Adaptor.java  | 13 ++++---
 .../datacollection/adaptor/SyslogAdaptor.java   |  8 ++---
 .../adaptor/filetailer/FileTailingAdaptor.java  |  1 -
 .../datacollection/adaptor/jms/JMSAdaptor.java  |  6 ++--
 .../jms/JMSMessagePropertyTransformer.java      |  2 +-
 .../adaptor/jms/JMSMessageTransformer.java      |  2 +-
 .../agent/AgentControlSocketListener.java       |  2 +-
 .../datacollection/agent/ChukwaAgent.java       |  3 +-
 .../agent/metrics/AgentMetrics.java             |  4 ++-
 .../agent/metrics/ChunkQueueMetrics.java        |  4 ++-
 .../agent/rest/AdaptorController.java           |  5 +++
 .../controller/ChukwaAgentController.java       | 15 +++++++-
 .../datacollection/sender/ChukwaSender.java     |  1 +
 .../sender/RetryListOfCollectors.java           |  4 +--
 .../sender/metrics/HttpSenderMetrics.java       |  4 ++-
 .../datacollection/writer/ChukwaWriter.java     |  2 +-
 .../chukwa/dataloader/DataLoaderFactory.java    |  4 ++-
 .../chukwa/dataloader/MetricDataLoader.java     |  5 ++-
 .../chukwa/datastore/ChukwaHBaseStore.java      | 38 +++++++++++++-------
 .../chukwa/extraction/demux/DemuxManager.java   |  8 ++---
 .../processor/mapper/ProcessorFactory.java      |  2 ++
 .../reducer/ReduceProcessorFactory.java         |  2 ++
 .../chukwa/extraction/engine/RecordUtil.java    |  2 ++
 .../extraction/hbase/AbstractProcessor.java     |  4 +--
 .../chukwa/hicc/rest/ChartController.java       | 13 ++++---
 .../chukwa/hicc/rest/CirclesController.java     |  4 +--
 .../chukwa/hicc/rest/SessionController.java     |  1 +
 .../log4j/ChukwaDailyRollingFileAppender.java   | 36 +++++++++++--------
 .../chukwa/rest/resource/ClientTrace.java       |  1 +
 .../apache/hadoop/chukwa/util/DumpChunks.java   |  7 ++--
 .../hadoop/chukwa/util/HierarchyDataType.java   |  9 ++---
 .../apache/hadoop/chukwa/util/RegexUtil.java    | 23 ++++++++++++
 .../apache/hadoop/chukwa/util/XssFilter.java    |  2 +-
 .../metrics/spi/AbstractMetricsContext.java     |  7 ++--
 .../chukwa/extraction/archive/TestArchive.java  |  1 +
 43 files changed, 228 insertions(+), 81 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/CHANGES.txt
----------------------------------------------------------------------
diff --git a/CHANGES.txt b/CHANGES.txt
index eacffbd..37d4fde 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1,6 +1,6 @@
 Chukwa Change Log
 
-Trunk (unreleased changes)
+Release 0.7 - (unreleased changes)
 
   NEW FEATURES
 
@@ -30,6 +30,8 @@ Trunk (unreleased changes)
 
   IMPROVEMENTS
 
+    CHUKWA-794. Update Javadoc to support JDK 1.8. (Eric Yang)
+
     CHUKWA-790. Update pom.xml to support JDK 1.8. (Eric Yang)
 
     CHUKWA-789. Added HBase schema to data model document. (Eric Yang)

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 68ae8cf..690ad82 100644
--- a/pom.xml
+++ b/pom.xml
@@ -393,6 +393,29 @@
         </testResources>
         <plugins>
             <plugin>
+              <groupId>org.apache.maven.plugins</groupId>
+              <artifactId>maven-project-info-reports-plugin</artifactId>
+              <version>2.8</version>
+              <dependencies>
+                <dependency>
+                  <groupId>org.apache.maven.shared</groupId>
+                  <artifactId>maven-shared-jar</artifactId>
+                  <version>1.1</version>
+                  <exclusions>
+                    <exclusion>
+                      <groupId>org.apache.bcel</groupId>
+                      <artifactId>bcel</artifactId>
+                    </exclusion>
+                  </exclusions>
+                </dependency>
+                <dependency>
+                  <groupId>com.google.code.findbugs</groupId>
+                  <artifactId>bcel-findbugs</artifactId>
+                  <version>6.0</version>
+                </dependency>
+              </dependencies>
+            </plugin>
+            <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-resources-plugin</artifactId>
                 <version>2.6</version>
@@ -480,9 +503,9 @@
                       <goals>
                         <goal>testCompile</goal>
                       </goals>
-                      <compilerVersion>1.6</compilerVersion>
-                      <source>1.6</source>
-                      <target>1.6</target>
+                      <compilerVersion>1.7</compilerVersion>
+                      <source>1.7</source>
+                      <target>1.7</target>
                       <testExcludes>
                         <exclude>**/ChukwaJobTrackerInstrumentation.java</exclude>
                         <exclude>**/TestDemuxManager.java</exclude>
@@ -1404,6 +1427,7 @@
               <configuration>
                 <aggregate>true</aggregate>
                 <doctitle>${project.name} API ${project.version}</doctitle>
+                <failOnError>false</failOnError>
               </configuration>
               <reports>
                 <report>javadoc</report>

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/Chunk.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/Chunk.java b/src/main/java/org/apache/hadoop/chukwa/Chunk.java
index f1a208e..d3c5467 100644
--- a/src/main/java/org/apache/hadoop/chukwa/Chunk.java
+++ b/src/main/java/org/apache/hadoop/chukwa/Chunk.java
@@ -91,6 +91,7 @@ public interface Chunk {
   /**
    * Retrieve a reference to the adaptor that sent this event. Used by
    * LocalAgent and Connectors to deliver acks to the appropriate place.
+   * @return 
    */
   public Adaptor getInitiator();
 
@@ -110,6 +111,7 @@ public interface Chunk {
 
   /**
    * Add tag.
+   * @param tag 
    * 
    */
   public void addTag(String tag);

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Heatmap.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Heatmap.java b/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Heatmap.java
index 37f341c..28f8813 100644
--- a/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Heatmap.java
+++ b/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Heatmap.java
@@ -130,10 +130,11 @@ public class Heatmap {
   }
   
   /**
-   * @brief Constructor for Swimlanes visualization object
+   * Constructor for Swimlanes visualization object
    * @param timezone Timezone string from environment
    * @param cluster Cluster name from environment
    * @param event_type Whether to display shuffles or not
+   * @param query_stat_type 
    * @param valmap HashMap of key/value pairs simulating parameters from a HttpRequest
    */
   public Heatmap
@@ -227,6 +228,8 @@ public class Heatmap {
   /**
    * Set dimensions of image to be generated
    * Call before calling @see #run
+   * @param width 
+   * @param height 
    */
   public void setDimensions(int width, int height) {
     this.SIZE_X=width;
@@ -236,6 +239,7 @@ public class Heatmap {
   /**
    * Specify whether to print labels of hosts along axes
    * Call before calling @see #run
+   * @param legendopt 
    */
   public void setLegend(boolean legendopt) {
     if (legendopt) {
@@ -249,6 +253,10 @@ public class Heatmap {
   /**
    * Generates image in specified format, and writes image as binary
    * output to supplied output stream 
+   * @param output 
+   * @param img_fmt 
+   * @param scale 
+   * @return 
    */
   public boolean getImage(java.io.OutputStream output, String img_fmt, double scale) {
     dis = new Display(this.viz);
@@ -526,6 +534,7 @@ public class Heatmap {
   /**
    * Interfaces with database to get data and 
    * populate data structures for rendering
+   * @return 
    */
   @edu.umd.cs.findbugs.annotations.SuppressWarnings(value =
       "SQL_NONCONSTANT_STRING_PASSED_TO_EXECUTE", 

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Swimlanes.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Swimlanes.java b/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Swimlanes.java
index 07d9576..7128bd8 100644
--- a/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Swimlanes.java
+++ b/src/main/java/org/apache/hadoop/chukwa/analysis/salsa/visualization/Swimlanes.java
@@ -443,7 +443,7 @@ public class Swimlanes {
   }
   
   /**
-   * @brief Constructor for Swimlanes visualization object
+   * Constructor for Swimlanes visualization object
    * @param timezone Timezone string from environment
    * @param cluster Cluster name from environment
    * @param event_type Whether to display shuffles or not
@@ -533,6 +533,7 @@ public class Swimlanes {
   /**
    * Set job ID to filter results on
    * Call before calling @see #run
+   * @param s 
    */
   public void setJobName(String s) {
     this.jobname = s;
@@ -541,6 +542,8 @@ public class Swimlanes {
   /**
    * Set dimensions of image to be generated
    * Call before calling @see #run
+   * @param width 
+   * @param height 
    */  
   public void setDimensions(int width, int height) {
     this.SIZE_X=width;
@@ -552,6 +555,7 @@ public class Swimlanes {
    * Advisable to not print legend for excessively small images since
    * legend has fixed point size
    * Call before calling @see #run
+   * @param legendopt 
    */
   public void setLegend(boolean legendopt) {
     if (legendopt) {
@@ -564,6 +568,10 @@ public class Swimlanes {
   /**
    * Generates image in specified format, and writes image as binary
    * output to supplied output stream 
+   * @param output 
+   * @param img_fmt 
+   * @param scale 
+   * @return 
    */
   public boolean getImage(java.io.OutputStream output, String img_fmt, double scale) {
     dis = new Display(this.viz);

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/ChunkQueue.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/ChunkQueue.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/ChunkQueue.java
index 5ed8e4a..63cb78e 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/ChunkQueue.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/ChunkQueue.java
@@ -39,6 +39,9 @@ public interface ChunkQueue extends ChunkReceiver {
   /**
    * Return at least one, and no more than count, Chunks into chunks. Blocks if
    * queue is empty.
+   * @param chunks 
+   * @param count 
+   * @throws InterruptedException 
    */
   public void collect(List<Chunk> chunks, int count)
       throws InterruptedException;
@@ -46,6 +49,7 @@ public interface ChunkQueue extends ChunkReceiver {
   /**
    * Return an approximation of the number of chunks in the queue currently. No
    * guarantees are made about the accuracy of this number.
+   * @return 
    */
   public int size();
 }

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/DataFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/DataFactory.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/DataFactory.java
index f27b806..30d1fe7 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/DataFactory.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/DataFactory.java
@@ -107,6 +107,8 @@ public class DataFactory {
   }
   
   /**
+   * @param conf 
+   * @param filename 
    * @return empty list if file does not exist
    * @throws IOException on other error
    */

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/OffsetStatsManager.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/OffsetStatsManager.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/OffsetStatsManager.java
index 497f738..f724d11 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/OffsetStatsManager.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/OffsetStatsManager.java
@@ -37,6 +37,7 @@ import java.util.concurrent.TimeUnit;
  * <P>
  * Care should be taken to always call <code>remove()</code> when old T objects
  * should no longer be tracked.
+ * @param <T> 
  */
 public class OffsetStatsManager<T> {
   protected Logger log = Logger.getLogger(getClass());

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/Adaptor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/Adaptor.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/Adaptor.java
index 2d92960..55a78b3 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/Adaptor.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/Adaptor.java
@@ -34,7 +34,7 @@ import org.apache.hadoop.chukwa.datacollection.agent.AdaptorManager;
  * offset in the stream.
  * 
  * If an adaptor crashes at byte offset n, and is restarted at byte offset k,
- * with k < n, it is allowed to send different values for bytes k through n the
+ * with k &#60; n, it is allowed to send different values for bytes k through n the
  * second time around. However, the stream must still be parseable, assuming
  * that bytes 0-k come from the first run,and bytes k - n come from the second.
  * 
@@ -48,10 +48,11 @@ import org.apache.hadoop.chukwa.datacollection.agent.AdaptorManager;
 public interface Adaptor {
   /**
    * Start this adaptor
-   * 
+   *
+   * @param adaptorID cutomized application ID
    * @param type the application type, who is starting this adaptor
-   * @param status the status string to use for configuration.
    * @param offset the stream offset of the first byte sent by this adaptor
+   * @param dest receiver of the chunk
    * @throws AdaptorException
    */
   public void start(String adaptorID, String type, long offset,
@@ -74,6 +75,9 @@ public interface Adaptor {
    * Return the stream name, given params.
    * The stream name is the part of the Adaptor status that's used to 
    * determine uniqueness. 
+   * @param datatype 
+   * @param params 
+   * @param c 
    * 
    * @return Stream name as a string, null if params are malformed
    */
@@ -84,6 +88,7 @@ public interface Adaptor {
   /**
    * Signals this adaptor to come to an orderly stop. The adaptor ought to push
    * out all the data it can before exiting depending of the shutdown policy
+   * @param shutdownPolicy 
    * 
    * @return the logical offset at which the adaptor was when the method return
    * @throws AdaptorException
@@ -120,4 +125,4 @@ public interface Adaptor {
 //  @Deprecated
 //  public void hardStop() throws AdaptorException;
 
-}
\ No newline at end of file
+}

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/SyslogAdaptor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/SyslogAdaptor.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/SyslogAdaptor.java
index 50dec64..6ca4d14 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/SyslogAdaptor.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/SyslogAdaptor.java
@@ -38,10 +38,10 @@ import org.apache.log4j.Logger;
  * 
  * Data Type mapping can be overwritten in Chukwa Agent Configuration file, i.e.:
  * 
- * <property>
- *   <name>syslog.adaptor.port.9095.facility.LOCAL1</name>
- *   <value>HADOOP</value>
- * </property>
+ * &lt;property&gt;
+ *   &lt;name&gt;syslog.adaptor.port.9095.facility.LOCAL1&lt;/name&gt;
+ *   &lt;value&gt;HADOOP&lt;/value&gt;
+ * &lt;/property&gt;
  * 
  * When demux takes place, data received on port 9095 with facility name LOCAL0 will
  * be processed by demux parser for data type "HADOOP".

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/filetailer/FileTailingAdaptor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/filetailer/FileTailingAdaptor.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/filetailer/FileTailingAdaptor.java
index 9fc25b9..b5692fb 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/filetailer/FileTailingAdaptor.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/filetailer/FileTailingAdaptor.java
@@ -114,7 +114,6 @@ public class FileTailingAdaptor extends LWFTAdaptor {
    * This method is not thread safe. Returns true if there's more data in the
    * file
    * 
-   * @param eq the queue to write Chunks into
    */
   @Override
   public boolean tailFile()

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSAdaptor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSAdaptor.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSAdaptor.java
index 79f8db6..9757a07 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSAdaptor.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSAdaptor.java
@@ -122,8 +122,8 @@ public class JMSAdaptor extends AbstractAdaptor {
    * <brokerURL> <-t <topicName>|-q <queueName>> [-s <JMSSelector>] [-x <transformerName>]
    * [-p <transformerProperties>]
    *
-   * @param s
-   * @return
+   * @param s input string
+   * @return input string
    */
   @Override
   public String parseArgs(String s) {
@@ -283,7 +283,7 @@ public class JMSAdaptor extends AbstractAdaptor {
    *
    * Without the first token in <currentStatus>, which is expected to be <dataType>.
    *
-   * @return
+   * @return status
    */
   @Override
   public String getCurrentStatus() {

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessagePropertyTransformer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessagePropertyTransformer.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessagePropertyTransformer.java
index facff2d..72a717b 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessagePropertyTransformer.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessagePropertyTransformer.java
@@ -108,7 +108,7 @@ public class JMSMessagePropertyTransformer implements JMSMessageTransformer {
    * <P>
    * The could be enhanced to support the concept of optional/required properties.
    * @param message
-   * @return
+   * @return byte array message
    * @throws JMSException
    */
   public byte[] transform(Message message) throws JMSException {

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessageTransformer.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessageTransformer.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessageTransformer.java
index de2328f..fe3e3fa 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessageTransformer.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/adaptor/jms/JMSMessageTransformer.java
@@ -33,7 +33,7 @@ public interface JMSMessageTransformer {
    * passed. If they weren't, this method will never be called.
    *
    * @param args Arguments needed to configur the transformer.
-   * @return
+   * @return input string
    */
   public String parseArgs(String args);
 

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/AgentControlSocketListener.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/AgentControlSocketListener.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/AgentControlSocketListener.java
index d024180..63a9c88 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/AgentControlSocketListener.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/AgentControlSocketListener.java
@@ -206,7 +206,7 @@ public class AgentControlSocketListener extends Thread {
   /**
    * Initializes listener, but does not bind to socket.
    * 
-   * @param a the agent to control
+   * @param agent the agent to control
    */
   public AgentControlSocketListener(ChukwaAgent agent) {
 

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/ChukwaAgent.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/ChukwaAgent.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/ChukwaAgent.java
index 0d201e7..38c4180 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/ChukwaAgent.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/ChukwaAgent.java
@@ -604,7 +604,7 @@ public class ChukwaAgent implements AdaptorManager {
 /**
  * Expose the adaptor list.  Keys are adaptor ID numbers, values are the 
  * adaptor status strings.
- * @return
+ * @return adaptors
  */
   public Map<String, String> getAdaptorList() {
     Map<String, String> adaptors = new HashMap<String, String>(adaptorsByName.size());
@@ -700,6 +700,7 @@ public class ChukwaAgent implements AdaptorManager {
   /**
    * Triggers agent shutdown. For now, this method doesn't shut down adaptors
    * explicitly. It probably should.
+   * @param exit 
    */
   public void shutdown(boolean exit) {
     controlSock.shutdown(); // make sure we don't get new requests

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/AgentMetrics.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/AgentMetrics.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/AgentMetrics.java
index 34bd2ed..1647343 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/AgentMetrics.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/AgentMetrics.java
@@ -42,7 +42,9 @@ public class AgentMetrics implements Updater {
   public MetricsTimeVaryingInt removedAdaptor =
     new MetricsTimeVaryingInt("removedAdaptor", registry,"number of removed adaptor");
   
-  /** Creates a new instance of AgentMetrics */
+  /** Creates a new instance of AgentMetrics 
+   * @param processName 
+   * @param recordName */
   public AgentMetrics(String processName, String recordName) {
       MetricsContext context = MetricsUtil.getContext(processName);
       metricsRecord = MetricsUtil.createRecord(context, recordName);

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/ChunkQueueMetrics.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/ChunkQueueMetrics.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/ChunkQueueMetrics.java
index 930358f..72f76b5 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/ChunkQueueMetrics.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/metrics/ChunkQueueMetrics.java
@@ -50,7 +50,9 @@ public class ChunkQueueMetrics implements Updater {
     new MetricsIntValue("fullQueue", registry,"Queue is full");
   
   
-  /** Creates a new instance of QueueMetrics */
+  /** Creates a new instance of QueueMetrics 
+   * @param processName 
+   * @param recordName */
   public ChunkQueueMetrics(String processName, String recordName) {
       MetricsContext context = MetricsUtil.getContext(processName);
       metricsRecord = MetricsUtil.createRecord(context, recordName);

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorController.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorController.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorController.java
index dc44975..d461279 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorController.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/agent/rest/AdaptorController.java
@@ -57,6 +57,8 @@ public class AdaptorController {
 
   /**
    * Adds an adaptor to the agent and returns the adaptor info
+   * @param ac 
+   * @return 
    * 
    * @request.representation.example {@link Examples#CREATE_ADAPTOR_SAMPLE}
    * @response.representation.200.doc Adaptor has been registered
@@ -99,6 +101,7 @@ public class AdaptorController {
    * Remove an adaptor from the agent
    *
    * @param adaptorId id of adaptor to remove.
+   * @return 
    * @response.representation.200.doc Delete adaptor by id
    * @response.representation.200.mediaType text/plain
    */
@@ -125,6 +128,7 @@ public class AdaptorController {
 
   /**
    * Get all adaptors
+   * @return 
    * 
    * @response.representation.200.doc List all configured adaptors
    * @response.representation.200.mediaType application/json
@@ -140,6 +144,7 @@ public class AdaptorController {
    * Get a single adaptor
    * 
    * @param adaptorId id of the adaptor to return
+   * @return 
    * @response.representation.200.doc Adaptor status and data transfer rate in 1, 5, 10 minutes averages
    * @response.representation.200.mediaType application/json
    * @response.representation.200.example {@link Examples#ADAPTOR_STATUS_SAMPLE}

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/controller/ChukwaAgentController.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/controller/ChukwaAgentController.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/controller/ChukwaAgentController.java
index 69e3566..8ae7cd9 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/controller/ChukwaAgentController.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/controller/ChukwaAgentController.java
@@ -230,6 +230,10 @@ public class ChukwaAgentController {
    * doesn't crash if it's attempt to register an adaptor fails. This call does
    * not retry a conection. for that use the overloaded version of this which
    * accepts a time interval and number of retries
+   * @param adaptorName 
+   * @param type 
+   * @param params 
+   * @param offset 
    * 
    * @return the id number of the adaptor, generated by the agent
    */
@@ -246,6 +250,13 @@ public class ChukwaAgentController {
    * Registers a new adaptor. Makes no guarantee about success. On failure, to
    * connect to server, will retry <code>numRetries</code> times, every
    * <code>retryInterval</code> milliseconds.
+   * @param adaptorID 
+   * @param adaptorName 
+   * @param type 
+   * @param params 
+   * @param offset 
+   * @param numRetries 
+   * @param retryInterval 
    * 
    * @return the id number of the adaptor, generated by the agent
    */
@@ -400,8 +411,10 @@ public class ChukwaAgentController {
    * {@link ChukwaAgentController#resumeFile(String, String)} which will store
    * the adaptors metadata and re-use them to pick up where it left off.
    * 
-   * @param type the datatype associated with the file to pass through
+   * @param appType the datatype associated with the file to pass through
    * @param filename of the file for the tail adaptor to start monitoring
+   * @param numRetries 
+   * @param retryInterval 
    * @return the id number of the adaptor, generated by the agent
    */
   public String addFile(String appType, String filename, long numRetries,

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/ChukwaSender.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/ChukwaSender.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/ChukwaSender.java
index 0a46ea1..44623d2 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/ChukwaSender.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/ChukwaSender.java
@@ -34,6 +34,7 @@ public interface ChukwaSender {
    * @param chunksToSend a list of chunks to commit
    * @return the list of committed chunks
    * @throws InterruptedException if interrupted while trying to send
+   * @throws java.io.IOException 
    */
   public List<CommitListEntry> send(List<Chunk> chunksToSend)
       throws InterruptedException, java.io.IOException;

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/RetryListOfCollectors.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/RetryListOfCollectors.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/RetryListOfCollectors.java
index c636ad2..c2cea60 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/RetryListOfCollectors.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/RetryListOfCollectors.java
@@ -95,8 +95,8 @@ public class RetryListOfCollectors implements Iterator<String>, Cloneable {
   /**
    * This is only used for debugging. Possibly it should sanitize urls the same way the other
    * constructor does.
-   * @param collectors
-   * @param maxRetryRateMs
+   * @param collectors List of collectors
+   * @param conf Chukwa Configuration
    */
   public RetryListOfCollectors(final List<String> collectors, Configuration conf) {
     this(conf);

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/metrics/HttpSenderMetrics.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/metrics/HttpSenderMetrics.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/metrics/HttpSenderMetrics.java
index e223736..34b6860 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/metrics/HttpSenderMetrics.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/sender/metrics/HttpSenderMetrics.java
@@ -47,7 +47,9 @@ public class HttpSenderMetrics implements Updater {
   public MetricsTimeVaryingInt httpTimeOutException =
     new MetricsTimeVaryingInt("httpTimeOutException", registry,"number of HTTP TimeOutException");
   
-  /** Creates a new instance of HttpSenderMetrics */
+  /** Creates a new instance of HttpSenderMetrics 
+   * @param processName 
+   * @param recordName */
   public HttpSenderMetrics(String processName, String recordName) {
       MetricsContext context = MetricsUtil.getContext(processName);
       metricsRecord = MetricsUtil.createRecord(context, recordName);

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datacollection/writer/ChukwaWriter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datacollection/writer/ChukwaWriter.java b/src/main/java/org/apache/hadoop/chukwa/datacollection/writer/ChukwaWriter.java
index 827c35a..2cb1c4d 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datacollection/writer/ChukwaWriter.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datacollection/writer/ChukwaWriter.java
@@ -68,7 +68,7 @@ public interface ChukwaWriter {
    * add(), and that add() won't be called after close().
    * 
    * @param chunks
-   * @return
+   * @return CommitStatus
    * @throws WriterException
    */
   public CommitStatus add(List<Chunk> chunks) throws WriterException;

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/dataloader/DataLoaderFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/dataloader/DataLoaderFactory.java b/src/main/java/org/apache/hadoop/chukwa/dataloader/DataLoaderFactory.java
index 3b8b946..6b1576e 100644
--- a/src/main/java/org/apache/hadoop/chukwa/dataloader/DataLoaderFactory.java
+++ b/src/main/java/org/apache/hadoop/chukwa/dataloader/DataLoaderFactory.java
@@ -35,7 +35,9 @@ public abstract class DataLoaderFactory {
   }
 
   /**
-   * @param args
+   * @param conf
+   * @param fs
+   * @param src
    * @throws IOException
    */
   public void load(ChukwaConfiguration conf, FileSystem fs, FileStatus[] src) throws IOException {

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/dataloader/MetricDataLoader.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/dataloader/MetricDataLoader.java b/src/main/java/org/apache/hadoop/chukwa/dataloader/MetricDataLoader.java
index 5538a40..168481c 100644
--- a/src/main/java/org/apache/hadoop/chukwa/dataloader/MetricDataLoader.java
+++ b/src/main/java/org/apache/hadoop/chukwa/dataloader/MetricDataLoader.java
@@ -72,7 +72,10 @@ public class MetricDataLoader implements Callable {
     fs = FileSystem.get(conf);
   }
 
-  /** Creates a new instance of DBWriter */
+  /** Creates a new instance of DBWriter 
+   * @param conf 
+   * @param fs 
+   * @param fileName */
   public MetricDataLoader(ChukwaConfiguration conf, FileSystem fs, String fileName) {
     source = new Path(fileName);
     this.conf = conf;

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/datastore/ChukwaHBaseStore.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/datastore/ChukwaHBaseStore.java b/src/main/java/org/apache/hadoop/chukwa/datastore/ChukwaHBaseStore.java
index bdd765d..d26d631 100644
--- a/src/main/java/org/apache/hadoop/chukwa/datastore/ChukwaHBaseStore.java
+++ b/src/main/java/org/apache/hadoop/chukwa/datastore/ChukwaHBaseStore.java
@@ -116,7 +116,7 @@ public class ChukwaHBaseStore {
    * @param source
    * @param startTime
    * @param endTime
-   * @return
+   * @return Series
    */
   public static Series getSeries(String metricGroup, String metric,
       String source, long startTime, long endTime) {
@@ -132,7 +132,7 @@ public class ChukwaHBaseStore {
    * @param source
    * @param startTime
    * @param endTime
-   * @return
+   * @return Series
    */
   public static synchronized Series getSeries(String metric, String source, long startTime,
       long endTime) {
@@ -343,7 +343,7 @@ public class ChukwaHBaseStore {
    * 
    * @param startTime
    * @param endTime
-   * @return
+   * @return Set<String> of cluster names
    */
   public static Set<String> getClusterNames(long startTime, long endTime) {
     Set<String> clusters = new HashSet<String>();
@@ -375,7 +375,7 @@ public class ChukwaHBaseStore {
    * Get a chart from HBase by ID.
    * 
    * @param id
-   * @return
+   * @return Chart
    */
   public static Chart getChart(String id) {
     Chart chart = null;
@@ -422,6 +422,12 @@ public class ChukwaHBaseStore {
 
   /**
    * Create a chart in HBase by specifying parameters.
+   * @param id 
+   * @param title 
+   * @param metrics 
+   * @param source 
+   * @param yunitType 
+   * @return 
    * @throws URISyntaxException 
    */
   public static synchronized String createChart(String id,
@@ -446,6 +452,13 @@ public class ChukwaHBaseStore {
 
   /**
    * Create a chart in HBase by specifying parameters.
+   * @param id 
+   * @param title 
+   * @param metrics 
+   * @param source 
+   * @param suffixLabel 
+   * @param direction 
+   * @return 
    * @throws URISyntaxException 
    */
   public static synchronized String createCircle(String id,
@@ -476,7 +489,7 @@ public class ChukwaHBaseStore {
    * @param metrics
    * @param source
    * @param icon
-   * @return
+   * @return html
    * @throws URISyntaxException
    */
   public static synchronized String createTile(String id, String title, 
@@ -502,7 +515,6 @@ public class ChukwaHBaseStore {
    * 
    * @param chart
    * @return id of newly created chart
-   * @throws IOException
    */
   public static synchronized String createChart(Chart chart) {
     String id = chart.getId();
@@ -541,7 +553,7 @@ public class ChukwaHBaseStore {
    * @param series
    * @param startTime
    * @param endTime
-   * @return
+   * @return List of series meta data
    */
   public static synchronized ArrayList<org.apache.hadoop.chukwa.hicc.bean.SeriesMetaData> getChartSeries(ArrayList<org.apache.hadoop.chukwa.hicc.bean.SeriesMetaData> series, long startTime, long endTime) {
     ArrayList<org.apache.hadoop.chukwa.hicc.bean.SeriesMetaData> list = new ArrayList<org.apache.hadoop.chukwa.hicc.bean.SeriesMetaData>();
@@ -654,7 +666,7 @@ public class ChukwaHBaseStore {
    * 
    * @param limit
    * @param offset
-   * @return
+   * @return List of widgets
    */
   public static synchronized List<Widget> listWidget(int limit, int offset) {
     ArrayList<Widget> list = new ArrayList<Widget>();
@@ -739,7 +751,7 @@ public class ChukwaHBaseStore {
    * Find widget by title prefix in HBase.
    * 
    * @param query - Prefix query of widget title.
-   * @return
+   * @return List of widgets
    */
   public static synchronized List<Widget> searchWidget(String query) {
     ArrayList<Widget> list = new ArrayList<Widget>();
@@ -774,7 +786,7 @@ public class ChukwaHBaseStore {
    * View a widget information in HBase.
    * 
    * @param title - Title of the widget.
-   * @return
+   * @return Widget
    */
   public static synchronized Widget viewWidget(String title) {
     Widget w = null;
@@ -799,6 +811,7 @@ public class ChukwaHBaseStore {
    * Create a widget in HBase.
    * 
    * @param widget
+   * @return 
    */
   public static synchronized boolean createWidget(Widget widget) {
     boolean created = false;
@@ -832,7 +845,7 @@ public class ChukwaHBaseStore {
    * 
    * @param title
    * @param widget
-   * @throws IOException 
+   * @return 
    */
   public static synchronized boolean updateWidget(String title, Widget widget) {
     boolean result = false;
@@ -862,8 +875,7 @@ public class ChukwaHBaseStore {
    * Delete a widget in HBase.
    * 
    * @param title
-   * @param widget
-   * @throws IOException 
+   * @return 
    */
   public static synchronized boolean deleteWidget(String title) {
     boolean result = false;

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/extraction/demux/DemuxManager.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/extraction/demux/DemuxManager.java b/src/main/java/org/apache/hadoop/chukwa/extraction/demux/DemuxManager.java
index 9fcb65b..f7e9d85 100644
--- a/src/main/java/org/apache/hadoop/chukwa/extraction/demux/DemuxManager.java
+++ b/src/main/java/org/apache/hadoop/chukwa/extraction/demux/DemuxManager.java
@@ -408,8 +408,8 @@ public class DemuxManager implements CHUKWA_CONSTANT {
 
    /**
     * Move sourceFolder inside destFolder
-    * @param demuxInputDir: ex chukwa/demux/inputDir
-    * @param archiveDirectory: ex /chukwa/archives
+    * @param demuxInputDir ex chukwa/demux/inputDir
+    * @param archiveDirectory ex /chukwa/archives
     * @return true if able to move chukwa/demux/inputDir to /chukwa/archives/raw/<YYYYMMDD>/dataSinkDirXXX
     * @throws IOException
     */
@@ -421,8 +421,8 @@ public class DemuxManager implements CHUKWA_CONSTANT {
 
    /**
     * Move sourceFolder inside destFolder
-    * @param demuxOutputDir: ex chukwa/demux/outputDir 
-    * @param postProcessDirectory: ex /chukwa/postProcess
+    * @param demuxOutputDir ex chukwa/demux/outputDir 
+    * @param postProcessDirectory ex /chukwa/postProcess
     * @return true if able to move chukwa/demux/outputDir to /chukwa/postProcess/demuxOutputDirXXX
     * @throws IOException 
     */

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/mapper/ProcessorFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/mapper/ProcessorFactory.java b/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/mapper/ProcessorFactory.java
index 4f10532..e3ccb2e 100644
--- a/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/mapper/ProcessorFactory.java
+++ b/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/mapper/ProcessorFactory.java
@@ -65,6 +65,8 @@ public class ProcessorFactory {
 
   /**
    * Register a specific parser for a {@link ChunkProcessor} implementation.
+   * @param recordType 
+   * @param processor 
    */
   public static synchronized void register(String recordType,
       ChunkProcessor processor) {

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/reducer/ReduceProcessorFactory.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/reducer/ReduceProcessorFactory.java b/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/reducer/ReduceProcessorFactory.java
index 19b3f45..92afca5 100644
--- a/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/reducer/ReduceProcessorFactory.java
+++ b/src/main/java/org/apache/hadoop/chukwa/extraction/demux/processor/reducer/ReduceProcessorFactory.java
@@ -44,6 +44,8 @@ public class ReduceProcessorFactory {
 
   /**
    * Register a specific parser for a {@link ReduceProcessor} implementation.
+   * @param reduceType 
+   * @param processor 
    */
   public static synchronized void register(String reduceType,
                                            ReduceProcessor processor) {

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/extraction/engine/RecordUtil.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/extraction/engine/RecordUtil.java b/src/main/java/org/apache/hadoop/chukwa/extraction/engine/RecordUtil.java
index 291e509..3ae8005 100644
--- a/src/main/java/org/apache/hadoop/chukwa/extraction/engine/RecordUtil.java
+++ b/src/main/java/org/apache/hadoop/chukwa/extraction/engine/RecordUtil.java
@@ -45,6 +45,8 @@ public class RecordUtil {
   /**
    * Uses a precompiled pattern, so theoretically faster than
    * Chunk.getTag().
+   * @param chunk 
+   * @return 
    * 
    */
   public static String getClusterName(Chunk chunk) {

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/extraction/hbase/AbstractProcessor.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/extraction/hbase/AbstractProcessor.java b/src/main/java/org/apache/hadoop/chukwa/extraction/hbase/AbstractProcessor.java
index 4f5f289..3e2ff33 100644
--- a/src/main/java/org/apache/hadoop/chukwa/extraction/hbase/AbstractProcessor.java
+++ b/src/main/java/org/apache/hadoop/chukwa/extraction/hbase/AbstractProcessor.java
@@ -86,10 +86,8 @@ public abstract class AbstractProcessor {
    * assumes "time" and "source" have been defined and will construct primaryKey
    * only, without recompute time and source md5.
    * 
-   * @param time
-   * @param primaryKey
+   * @param metric
    * @param value
-   * @param output
    */
   public void addRecord(String metric, byte[] value) {
     String primaryKey = new StringBuilder(primaryKeyHelper).append(".")

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/hicc/rest/ChartController.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/hicc/rest/ChartController.java b/src/main/java/org/apache/hadoop/chukwa/hicc/rest/ChartController.java
index 41ef551..13cfd00 100644
--- a/src/main/java/org/apache/hadoop/chukwa/hicc/rest/ChartController.java
+++ b/src/main/java/org/apache/hadoop/chukwa/hicc/rest/ChartController.java
@@ -88,6 +88,8 @@ public class ChartController {
 
   /**
    * Describe chart meta data
+   * @param id 
+   * @return 
    */
   @GET
   @Path("describe/{id}")
@@ -102,8 +104,8 @@ public class ChartController {
   /**
    * Create a new chart meta data
    * 
-   * @param chart
-   * @return
+   * @param buffer JSON description of a chart object
+   * @return web response
    */
   @POST
   @Path("save")
@@ -121,8 +123,9 @@ public class ChartController {
   /**
    * Save chart meta data
    * 
-   * @param chart
-   * @return
+   * @param id chart id
+   * @param buffer JSON description of a chart object
+   * @return web response
    */
   @PUT
   @Path("save/{id}")
@@ -137,6 +140,8 @@ public class ChartController {
 
   /**
    * Preview a chart
+   * @param buffer 
+   * @return 
    */
   @PUT
   @Path("preview")

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/hicc/rest/CirclesController.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/hicc/rest/CirclesController.java b/src/main/java/org/apache/hadoop/chukwa/hicc/rest/CirclesController.java
index 5127b1c..17e807d 100644
--- a/src/main/java/org/apache/hadoop/chukwa/hicc/rest/CirclesController.java
+++ b/src/main/java/org/apache/hadoop/chukwa/hicc/rest/CirclesController.java
@@ -59,9 +59,7 @@ public class CirclesController {
   /**
    * Render circle using jquery circliful.js
    * 
-   * @param title Title of the tile.
-   * @param metric Metric name to lookup in hbase.
-   * @param source Metric source.
+   * @param id Chart id
    * @param invert Toggle to display warning, error color by upper bound or lower bound.
    * @return html circle widget.
    */

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/hicc/rest/SessionController.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/hicc/rest/SessionController.java b/src/main/java/org/apache/hadoop/chukwa/hicc/rest/SessionController.java
index 1441253..900302b 100644
--- a/src/main/java/org/apache/hadoop/chukwa/hicc/rest/SessionController.java
+++ b/src/main/java/org/apache/hadoop/chukwa/hicc/rest/SessionController.java
@@ -44,6 +44,7 @@ public class SessionController {
 
   /**
    * Utility to get session attributes
+   * @param request 
    * @param id
    * @return session attribute
    */

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/inputtools/log4j/ChukwaDailyRollingFileAppender.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/inputtools/log4j/ChukwaDailyRollingFileAppender.java b/src/main/java/org/apache/hadoop/chukwa/inputtools/log4j/ChukwaDailyRollingFileAppender.java
index 72b6dfd..a02e8dd 100644
--- a/src/main/java/org/apache/hadoop/chukwa/inputtools/log4j/ChukwaDailyRollingFileAppender.java
+++ b/src/main/java/org/apache/hadoop/chukwa/inputtools/log4j/ChukwaDailyRollingFileAppender.java
@@ -82,18 +82,19 @@ import org.apache.log4j.spi.LoggingEvent;
     <th>DatePattern</th>
     <th>Rollover schedule</th>
     <th>Example</th>
+    </tr>
 
     <tr>
-    <td><code>'.'yyyy-MM</code>
+    <td><code>'.'yyyy-MM</code></td>
     <td>Rollover at the beginning of each month</td>
 
     <td>At midnight of May 31st, 2002 <code>/foo/bar.log</code> will be
     copied to <code>/foo/bar.log.2002-05</code>. Logging for the month
     of June will be output to <code>/foo/bar.log</code> until it is
-    also rolled over the next month.
+    also rolled over the next month.</td></tr>
 
     <tr>
-    <td><code>'.'yyyy-ww</code>
+    <td><code>'.'yyyy-ww</code></td>
 
     <td>Rollover at the first day of each week. The first day of the
     week depends on the locale.</td>
@@ -102,30 +103,30 @@ import org.apache.log4j.spi.LoggingEvent;
     midnight, June 9th 2002, the file <i>/foo/bar.log</i> will be
     copied to <i>/foo/bar.log.2002-23</i>.  Logging for the 24th week
     of 2002 will be output to <code>/foo/bar.log</code> until it is
-    rolled over the next week.
+    rolled over the next week.</td></tr>
 
     <tr>
-    <td><code>'.'yyyy-MM-dd</code>
+    <td><code>'.'yyyy-MM-dd</code></td>
 
     <td>Rollover at midnight each day.</td>
 
     <td>At midnight, on March 8th, 2002, <code>/foo/bar.log</code> will
     be copied to <code>/foo/bar.log.2002-03-08</code>. Logging for the
     9th day of March will be output to <code>/foo/bar.log</code> until
-    it is rolled over the next day.
+    it is rolled over the next day.</td></tr>
 
     <tr>
-    <td><code>'.'yyyy-MM-dd-a</code>
+    <td><code>'.'yyyy-MM-dd-a</code></td>
 
     <td>Rollover at midnight and midday of each day.</td>
 
     <td>At noon, on March 9th, 2002, <code>/foo/bar.log</code> will be
     copied to <code>/foo/bar.log.2002-03-09-AM</code>. Logging for the
     afternoon of the 9th will be output to <code>/foo/bar.log</code>
-    until it is rolled over at midnight.
+    until it is rolled over at midnight.</td></tr>
 
     <tr>
-    <td><code>'.'yyyy-MM-dd-HH</code>
+    <td><code>'.'yyyy-MM-dd-HH</code></td>
 
     <td>Rollover at the top of every hour.</td>
 
@@ -133,11 +134,11 @@ import org.apache.log4j.spi.LoggingEvent;
     <code>/foo/bar.log</code> will be copied to
     <code>/foo/bar.log.2002-03-09-10</code>. Logging for the 11th hour
     of the 9th of March will be output to <code>/foo/bar.log</code>
-    until it is rolled over at the beginning of the next hour.
+    until it is rolled over at the beginning of the next hour.</td></tr>
 
 
     <tr>
-    <td><code>'.'yyyy-MM-dd-HH-mm</code>
+    <td><code>'.'yyyy-MM-dd-HH-mm</code></td>
 
     <td>Rollover at the beginning of every minute.</td>
 
@@ -145,14 +146,14 @@ import org.apache.log4j.spi.LoggingEvent;
     <code>/foo/bar.log</code> will be copied to
     <code>/foo/bar.log.2001-03-09-10-22</code>. Logging for the minute
     of 11:23 (9th of March) will be output to
-    <code>/foo/bar.log</code> until it is rolled over the next minute.
+    <code>/foo/bar.log</code> until it is rolled over the next minute.</td></tr>
 
     </table>
 
     <p>Do not use the colon ":" character in anywhere in the
     <b>DatePattern</b> option. The text before the colon is interpeted
     as the protocol specificaion of a URL which is probably not what
-    you want. */
+    you want.</p> */
 
 public class ChukwaDailyRollingFileAppender extends FileAppender {
 
@@ -230,6 +231,7 @@ public class ChukwaDailyRollingFileAppender extends FileAppender {
 
   /**
    * The default constructor does nothing.
+   * @throws IOException 
    */
   public ChukwaDailyRollingFileAppender() throws IOException {
     super();
@@ -239,6 +241,10 @@ public class ChukwaDailyRollingFileAppender extends FileAppender {
      Instantiate a <code>DailyRollingFileAppender</code> and open the
      file designated by <code>filename</code>. The opened filename will
      become the output destination for this appender.
+ * @param layout 
+ * @param filename 
+ * @param datePattern 
+ * @throws IOException 
 
    */
   public ChukwaDailyRollingFileAppender(Layout layout, String filename,
@@ -253,12 +259,14 @@ public class ChukwaDailyRollingFileAppender extends FileAppender {
   /**
    * The <b>DatePattern</b> takes a string in the same format as expected by
    * {@link SimpleDateFormat}. This options determines the rollover schedule.
+   * @param pattern 
    */
   public void setDatePattern(String pattern) {
     datePattern = pattern;
   }
 
-  /** Returns the value of the <b>DatePattern</b> option. */
+  /** Returns the value of the <b>DatePattern</b> option. 
+   * @return */
   public String getDatePattern() {
     return datePattern;
   }

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/rest/resource/ClientTrace.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/rest/resource/ClientTrace.java b/src/main/java/org/apache/hadoop/chukwa/rest/resource/ClientTrace.java
index ca97be1..0507cf2 100644
--- a/src/main/java/org/apache/hadoop/chukwa/rest/resource/ClientTrace.java
+++ b/src/main/java/org/apache/hadoop/chukwa/rest/resource/ClientTrace.java
@@ -55,6 +55,7 @@ public class ClientTrace {
    * src    - Source IP address
    * dest   - Destination IP address
    * size   - Size of the data payload.
+   * @return 
    * 
    */
   @GET

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/util/DumpChunks.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/util/DumpChunks.java b/src/main/java/org/apache/hadoop/chukwa/util/DumpChunks.java
index 11d1d1a..9995d4a 100644
--- a/src/main/java/org/apache/hadoop/chukwa/util/DumpChunks.java
+++ b/src/main/java/org/apache/hadoop/chukwa/util/DumpChunks.java
@@ -37,10 +37,13 @@ public class DumpChunks {
   
   /**
    * Tries to find chunks matching a given pattern.
-   * Takes as input a set of &-delimited patterns, followed
+   * Takes as input a set of &#38; delimited patterns, followed
    * by a list of file names.
    * 
-   * E.g:  Dump datatype=Iostat&source=/my/log/.* *.done
+   * E.g:  Dump datatype=Iostat&#38;source=/my/log/.* *.done
+   * @param args 
+   * @throws IOException 
+   * @throws URISyntaxException 
    */
   public static void main(String[] args) throws IOException, URISyntaxException {
     

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/util/HierarchyDataType.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/util/HierarchyDataType.java b/src/main/java/org/apache/hadoop/chukwa/util/HierarchyDataType.java
index 5a6a68b..eac9d39 100644
--- a/src/main/java/org/apache/hadoop/chukwa/util/HierarchyDataType.java
+++ b/src/main/java/org/apache/hadoop/chukwa/util/HierarchyDataType.java
@@ -50,7 +50,8 @@ public class HierarchyDataType {
    * @param fs The file system
    * @param path The parent folder
    * @param filter The pattern matcher to filter the required files
-   * @return
+   * @param recursive 
+   * @return List of file status
    */
   public static List<FileStatus> globStatus(FileSystem fs, Path path,
       PathFilter filter, boolean recursive) {
@@ -137,7 +138,7 @@ public class HierarchyDataType {
    * Get the directory without first and last slash mark.
    * 
    * @param datasource
-   * @return
+   * @return directory name
    */
   public static String trimSlash(String datasource) {
     String results = datasource;
@@ -155,7 +156,7 @@ public class HierarchyDataType {
    * slash mark)
    * 
    * @param datasource
-   * @return
+   * @return filename
    */
   public static String getHierarchyDataTypeFileName(String datasource){
     return datasource.replace("/", CHUKWA_CONSTANT.HIERARCHY_CONNECTOR);
@@ -166,7 +167,7 @@ public class HierarchyDataType {
    * slash mark)
    * 
    * @param datasource
-   * @return
+   * @return directory name
    */
   public static String getHierarchyDataTypeDirectory(String datasource) {
     return datasource.replace(CHUKWA_CONSTANT.HIERARCHY_CONNECTOR, "/");

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/util/RegexUtil.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/util/RegexUtil.java b/src/main/java/org/apache/hadoop/chukwa/util/RegexUtil.java
index b20d7f6..60c21fe 100644
--- a/src/main/java/org/apache/hadoop/chukwa/util/RegexUtil.java
+++ b/src/main/java/org/apache/hadoop/chukwa/util/RegexUtil.java
@@ -75,6 +75,7 @@ public class RegexUtil {
      * <p>
      * Consider calling this constructor with the result of
      * {@link RegexUtil#regexError}.
+     * @param pse 
      */
     public CheckedPatternSyntaxException(PatternSyntaxException pse) {
       this.pse = pse;
@@ -139,6 +140,8 @@ public class RegexUtil {
   /**
    * Returns true if the argument is a syntactically valid regular
    * expression.
+   * @param s 
+   * @return 
    */
   public static boolean isRegex(String s) {
     return isRegex(s, 0);
@@ -147,6 +150,9 @@ public class RegexUtil {
   /**
    * Returns true if the argument is a syntactically valid regular
    * expression with at least the given number of groups.
+   * @param s 
+   * @param groups 
+   * @return 
    */
   /*>>>
   @SuppressWarnings("regex")    // RegexUtil
@@ -165,6 +171,8 @@ public class RegexUtil {
   /**
    * Returns true if the argument is a syntactically valid regular
    * expression.
+   * @param c 
+   * @return 
    */
   /*>>>
   @SuppressWarnings("regex")    // RegexUtil
@@ -178,6 +186,8 @@ public class RegexUtil {
    * Returns null if the argument is a syntactically valid regular
    * expression. Otherwise returns a string describing why the argument is
    * not a regex.
+   * @param s 
+   * @return 
    */
   /*>>>
   @SuppressWarnings("regex")    // RegexUtil
@@ -191,6 +201,9 @@ public class RegexUtil {
    * Returns null if the argument is a syntactically valid regular
    * expression with at least the given number of groups. Otherwise returns
    * a string describing why the argument is not a regex.
+   * @param s 
+   * @param groups 
+   * @return 
    */
   /*>>>
   @SuppressWarnings("regex")    // RegexUtil
@@ -213,6 +226,8 @@ public class RegexUtil {
    * Returns null if the argument is a syntactically valid regular
    * expression. Otherwise returns a PatternSyntaxException describing
    * why the argument is not a regex.
+   * @param s 
+   * @return 
    */
   /*>>>
   @SuppressWarnings("regex")    // RegexUtil
@@ -226,6 +241,9 @@ public class RegexUtil {
    * Returns null if the argument is a syntactically valid regular
    * expression with at least the given number of groups. Otherwise returns a
    * PatternSyntaxException describing why the argument is not a regex.
+   * @param s 
+   * @param groups 
+   * @return 
    */
   /*>>>
   @SuppressWarnings("regex")    // RegexUtil
@@ -249,6 +267,8 @@ public class RegexUtil {
    * otherwise throws an error. The purpose of this method is to suppress Regex
    * Checker warnings. Once the the Regex Checker supports flow-sensitivity, it
    * should be very rarely needed.
+   * @param s 
+   * @return 
    */
   public static /*@Regex*/ String asRegex(String s) {
     return asRegex(s, 0);
@@ -259,6 +279,9 @@ public class RegexUtil {
    * with at least the given number of groups, otherwise throws an error. The
    * purpose of this method is to suppress Regex Checker warnings. Once the the
    * Regex Checker supports flow-sensitivity, it should be very rarely needed.
+   * @param s 
+   * @param groups 
+   * @return 
    */
   /*>>>
   @SuppressWarnings("regex")    // RegexUtil

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/chukwa/util/XssFilter.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/chukwa/util/XssFilter.java b/src/main/java/org/apache/hadoop/chukwa/util/XssFilter.java
index 1cf1267..312196f 100644
--- a/src/main/java/org/apache/hadoop/chukwa/util/XssFilter.java
+++ b/src/main/java/org/apache/hadoop/chukwa/util/XssFilter.java
@@ -66,7 +66,7 @@ public class XssFilter {
     /**
      * Strips any potential XSS threats out of the value
      * @param value
-     * @return
+     * @return sanitized html text
      */
     public String filter( String value ) {
       if( value == null )

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/main/java/org/apache/hadoop/metrics/spi/AbstractMetricsContext.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/hadoop/metrics/spi/AbstractMetricsContext.java b/src/main/java/org/apache/hadoop/metrics/spi/AbstractMetricsContext.java
index 6ab1e39..408c224 100644
--- a/src/main/java/org/apache/hadoop/metrics/spi/AbstractMetricsContext.java
+++ b/src/main/java/org/apache/hadoop/metrics/spi/AbstractMetricsContext.java
@@ -42,12 +42,12 @@ import org.apache.hadoop.metrics.Updater;
 /**
  * The main class of the Service Provider Interface.  This class should be
  * extended in order to integrate the Metrics API with a specific metrics
- * client library. <p/>
+ * client library.
  *
  * This class implements the internal table of metric data, and the timer
  * on which data is to be sent to the metrics system.  Subclasses must
  * override the abstract <code>emitRecord</code> method in order to transmit
- * the data. <p/>
+ * the data.
  */
 public abstract class AbstractMetricsContext implements MetricsContext {
     
@@ -70,6 +70,8 @@ public abstract class AbstractMetricsContext implements MetricsContext {
     }
     /**
      * Returns true if this tagmap contains every tag in other.
+     * @param other 
+     * @return 
      */
     public boolean containsAll(TagMap other) {
       for (Map.Entry<String,Object> entry : other.entrySet()) {
@@ -145,6 +147,7 @@ public abstract class AbstractMetricsContext implements MetricsContext {
     
   /**
    * Returns the factory by which this context was created.
+   * @return 
    */
   public ContextFactory getContextFactory() {
     return factory;

http://git-wip-us.apache.org/repos/asf/chukwa/blob/71cf0698/src/test/java/org/apache/hadoop/chukwa/extraction/archive/TestArchive.java
----------------------------------------------------------------------
diff --git a/src/test/java/org/apache/hadoop/chukwa/extraction/archive/TestArchive.java b/src/test/java/org/apache/hadoop/chukwa/extraction/archive/TestArchive.java
index e6de381..c2ca9c1 100644
--- a/src/test/java/org/apache/hadoop/chukwa/extraction/archive/TestArchive.java
+++ b/src/test/java/org/apache/hadoop/chukwa/extraction/archive/TestArchive.java
@@ -67,6 +67,7 @@ public class TestArchive extends TestCase {
   /**
    * Writes a single chunk to a file, checks that archiver delivers it
    * to an archive file with correct filename.
+   * @throws Exception 
    */
   public void testArchiving() throws Exception {
     FileSystem fileSys;


Mime
View raw message