You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@samza.apache.org by jm...@apache.org on 2017/05/09 22:07:45 UTC
samza git commit: SAMZA-1268: More javadoc cleanup for public APIs
for 0.13 release
Repository: samza
Updated Branches:
refs/heads/master 9e2ee35d6 -> 279a2952d
SAMZA-1268: More javadoc cleanup for public APIs for 0.13 release
Author: Prateek Maheshwari <pm...@linkedin.com>
Reviewers: Jacob Maes <jm...@linkedin.com>
Closes #175 from prateekm/documentation-cleanup
Project: http://git-wip-us.apache.org/repos/asf/samza/repo
Commit: http://git-wip-us.apache.org/repos/asf/samza/commit/279a2952
Tree: http://git-wip-us.apache.org/repos/asf/samza/tree/279a2952
Diff: http://git-wip-us.apache.org/repos/asf/samza/diff/279a2952
Branch: refs/heads/master
Commit: 279a2952d031c5d2075d6529c7c32e12112b10b2
Parents: 9e2ee35
Author: Prateek Maheshwari <pm...@linkedin.com>
Authored: Tue May 9 15:07:32 2017 -0700
Committer: Jacob Maes <jm...@linkedin.com>
Committed: Tue May 9 15:07:32 2017 -0700
----------------------------------------------------------------------
.../src/main/java/org/apache/samza/operators/windows/Window.java | 3 ++-
.../main/java/org/apache/samza/operators/windows/Windows.java | 4 ++--
2 files changed, 4 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/samza/blob/279a2952/samza-api/src/main/java/org/apache/samza/operators/windows/Window.java
----------------------------------------------------------------------
diff --git a/samza-api/src/main/java/org/apache/samza/operators/windows/Window.java b/samza-api/src/main/java/org/apache/samza/operators/windows/Window.java
index 321cc26..6f75993 100644
--- a/samza-api/src/main/java/org/apache/samza/operators/windows/Window.java
+++ b/samza-api/src/main/java/org/apache/samza/operators/windows/Window.java
@@ -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.
*
http://git-wip-us.apache.org/repos/asf/samza/blob/279a2952/samza-api/src/main/java/org/apache/samza/operators/windows/Windows.java
----------------------------------------------------------------------
diff --git a/samza-api/src/main/java/org/apache/samza/operators/windows/Windows.java b/samza-api/src/main/java/org/apache/samza/operators/windows/Windows.java
index bb837f6..b478cfa 100644
--- a/samza-api/src/main/java/org/apache/samza/operators/windows/Windows.java
+++ b/samza-api/src/main/java/org/apache/samza/operators/windows/Windows.java
@@ -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>