SAMZA-1268: More javadoc cleanup for public APIs for 0.13 release
authorPrateek Maheshwari <pmaheshw@linkedin.com>
Tue, 9 May 2017 22:07:32 +0000 (15:07 -0700)
committerJacob Maes <jmaes@linkedin.com>
Tue, 9 May 2017 22:07:32 +0000 (15:07 -0700)
Author: Prateek Maheshwari <pmaheshw@linkedin.com>

Reviewers: Jacob Maes <jmaes@linkedin.com>

Closes #175 from prateekm/documentation-cleanup

samza-api/src/main/java/org/apache/samza/operators/windows/Window.java
samza-api/src/main/java/org/apache/samza/operators/windows/Windows.java

index 321cc26..6f75993 100644 (file)
@@ -36,6 +36,7 @@ import org.apache.samza.operators.triggers.Trigger;
  *
  * <p> A {@link Window} is said to be as "keyed" when the incoming {@link org.apache.samza.operators.MessageStream}
  * is first grouped based on the provided key, and windowing is applied on the grouped stream.
+ * <pre>
  *
  *                                     window wk1 (with its triggers)
  *                                      +--------------------------------+
@@ -60,7 +61,7 @@ import org.apache.samza.operators.triggers.Trigger;
  *                                      |          |           |         |
  *                                      +----------+-----------+---------+
  *
- *
+ *</pre>
  * <p> Use {@link Windows} to create various windows and {@link org.apache.samza.operators.triggers.Triggers}
  * to create their triggers.
  *
index bb837f6..b478cfa 100644 (file)
@@ -44,7 +44,7 @@ import java.util.function.Supplier;
  *
  * <p> A window can have early triggers that allow emitting {@link WindowPane}s speculatively before all data
  * for the window has arrived, or late triggers that allow handling late arrivals of data.
- *
+ * <pre>
  *                                     window wk1
  *                                      +--------------------------------+
  *                                      ------------+--------+-----------+
@@ -68,7 +68,7 @@ import java.util.function.Supplier;
  *                                      |          |           |         |
  *                                      +----------+-----------+---------+
  *
- *
+ * </pre>
  * <p> A {@link Window} can be one of the following types:
  * <ul>
  *   <li>