From b3f303e45bef1e7b4b23a0d8773eb74b9acb6f2f Mon Sep 17 00:00:00 2001
From: zsxwing <zsxwing@gmail.com>
Date: Mon, 4 May 2015 17:14:20 -0700
Subject: [PATCH] Add comments for unclear classes and methods

---
 .../spark/streaming/ui/StreamingJobProgressListener.scala | 3 ++-
 .../org/apache/spark/streaming/ui/StreamingPage.scala     | 8 ++++++++
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingJobProgressListener.scala b/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingJobProgressListener.scala
index 0b6ca032bdd4f..68e8ce98945e0 100644
--- a/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingJobProgressListener.scala
+++ b/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingJobProgressListener.scala
@@ -186,7 +186,8 @@ private[streaming] class StreamingJobProgressListener(ssc: StreamingContext)
   def streamIds: Seq[Int] = ssc.graph.getInputStreams().map(_.id)
 
   /**
-   * Return all of the event rates for each InputDStream in each batch.
+   * Return all of the event rates for each InputDStream in each batch. The key of the return value
+   * is the stream id, and the value is a sequence of batch time with its event rate.
    */
   def receivedEventRateWithBatchTime: Map[Int, Seq[(Long, Double)]] = synchronized {
     val _retainedBatches = retainedBatches
diff --git a/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingPage.scala b/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingPage.scala
index f8ed28addabb0..4c78f4fadc4d6 100644
--- a/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingPage.scala
+++ b/streaming/src/main/scala/org/apache/spark/streaming/ui/StreamingPage.scala
@@ -30,6 +30,8 @@ import org.apache.spark.ui._
 import org.apache.spark.ui.{UIUtils => SparkUIUtils}
 
 /**
+ * A helper class to generate JavaScript and HTML for both timeline and histogram graphs.
+ *
  * @param timelineDivId the timeline `id` used in the html `div` tag
  * @param histogramDivId the timeline `id` used in the html `div` tag
  * @param data the data for the graph
@@ -95,6 +97,9 @@ private[ui] class GraphUIData(
 }
 
 /**
+ * A helper class for "scheduling delay", "processing time" and "total delay" to generate data that
+ * will be used in the timeline and histogram graphs.
+ *
  * @param data (batchTime, milliseconds). "milliseconds" is something like "processing time".
  */
 private[ui] class MillisecondsStatUIData(data: Seq[(Long, Long)]) {
@@ -119,6 +124,9 @@ private[ui] class MillisecondsStatUIData(data: Seq[(Long, Long)]) {
 }
 
 /**
+ * A helper class for "input rate" to generate data that will be used in the timeline and histogram
+ * graphs.
+ *
  * @param data (batchTime, event-rate).
  */
 private[ui] class EventRateUIData(val data: Seq[(Long, Double)]) {