You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@twill.apache.org by ch...@apache.org on 2015/07/24 20:29:37 UTC
[03/25] incubator-twill git commit: Add JavaDoc class header to give
short description.
Add JavaDoc class header to give short description.
Adding JavaDoc class header for several classes to help describe why and what they exist.
This closes #36 on GitHub
Signed-off-by: Terence Yim <ch...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/incubator-twill/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-twill/commit/70b68588
Tree: http://git-wip-us.apache.org/repos/asf/incubator-twill/tree/70b68588
Diff: http://git-wip-us.apache.org/repos/asf/incubator-twill/diff/70b68588
Branch: refs/heads/site
Commit: 70b6858857e763336e2bcf9a11110f34962db735
Parents: 2175c66
Author: hsaputra <hs...@apache.org>
Authored: Thu May 28 13:18:50 2015 -0700
Committer: Terence Yim <ch...@apache.org>
Committed: Thu May 28 13:56:19 2015 -0700
----------------------------------------------------------------------
.../src/main/java/org/apache/twill/internal/state/Message.java | 2 +-
.../main/java/org/apache/twill/internal/state/MessageCallback.java | 2 +-
.../main/java/org/apache/twill/internal/state/SimpleMessage.java | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/70b68588/twill-core/src/main/java/org/apache/twill/internal/state/Message.java
----------------------------------------------------------------------
diff --git a/twill-core/src/main/java/org/apache/twill/internal/state/Message.java b/twill-core/src/main/java/org/apache/twill/internal/state/Message.java
index 6c3e719..c6944fd 100644
--- a/twill-core/src/main/java/org/apache/twill/internal/state/Message.java
+++ b/twill-core/src/main/java/org/apache/twill/internal/state/Message.java
@@ -20,7 +20,7 @@ package org.apache.twill.internal.state;
import org.apache.twill.api.Command;
/**
- *
+ * Represent message objects to communicate between components in Twill.
*/
public interface Message {
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/70b68588/twill-core/src/main/java/org/apache/twill/internal/state/MessageCallback.java
----------------------------------------------------------------------
diff --git a/twill-core/src/main/java/org/apache/twill/internal/state/MessageCallback.java b/twill-core/src/main/java/org/apache/twill/internal/state/MessageCallback.java
index f94eaa3..4413a21 100644
--- a/twill-core/src/main/java/org/apache/twill/internal/state/MessageCallback.java
+++ b/twill-core/src/main/java/org/apache/twill/internal/state/MessageCallback.java
@@ -20,7 +20,7 @@ package org.apache.twill.internal.state;
import com.google.common.util.concurrent.ListenableFuture;
/**
- *
+ * Define interface that could provide override-able callback method when a message is received.
*/
public interface MessageCallback {
http://git-wip-us.apache.org/repos/asf/incubator-twill/blob/70b68588/twill-core/src/main/java/org/apache/twill/internal/state/SimpleMessage.java
----------------------------------------------------------------------
diff --git a/twill-core/src/main/java/org/apache/twill/internal/state/SimpleMessage.java b/twill-core/src/main/java/org/apache/twill/internal/state/SimpleMessage.java
index 9cfbe29..0465d46 100644
--- a/twill-core/src/main/java/org/apache/twill/internal/state/SimpleMessage.java
+++ b/twill-core/src/main/java/org/apache/twill/internal/state/SimpleMessage.java
@@ -21,7 +21,7 @@ import com.google.common.base.Objects;
import org.apache.twill.api.Command;
/**
- *
+ * Implementation of {@code Message} interface to pass information about {@code Command} to execute.
*/
final class SimpleMessage implements Message {