diff options
| author | Jannis Harder <harder@informatik.uni-luebeck.de> | 2011-05-10 03:54:48 +0200 |
|---|---|---|
| committer | Jannis Harder <harder@informatik.uni-luebeck.de> | 2011-05-10 03:54:48 +0200 |
| commit | 3b49b2053e9f9d26b73db0ffc8380a60706ee095 (patch) | |
| tree | 9678d5abb4af070bbf0fd89c684e91f5fd472c31 /src/jrummikub/control/ITurnTimer.java | |
| parent | 4a860e53cf6f2f97f18785673399498609e6504b (diff) | |
| download | JRummikub-3b49b2053e9f9d26b73db0ffc8380a60706ee095.tar JRummikub-3b49b2053e9f9d26b73db0ffc8380a60706ee095.zip | |
Added all missing comments
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@213 72836036-5685-4462-b002-a69064685172
Diffstat (limited to 'src/jrummikub/control/ITurnTimer.java')
| -rw-r--r-- | src/jrummikub/control/ITurnTimer.java | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/src/jrummikub/control/ITurnTimer.java b/src/jrummikub/control/ITurnTimer.java index 54f00b5..175d95f 100644 --- a/src/jrummikub/control/ITurnTimer.java +++ b/src/jrummikub/control/ITurnTimer.java @@ -2,12 +2,26 @@ package jrummikub.control; import jrummikub.util.IEvent; +/** + * Interface for the {@link TurnTimer} + */ public interface ITurnTimer { + /** + * Starts the timer + */ public abstract void startTimer(); + /** + * Stops the timer. Stopping an already stopped timer is a no-op. + */ public abstract void stopTimer(); + /** + * Returns the event that is emitted if the timer timed out. + * + * @return time out event + */ public abstract IEvent getTimeRunOutEvent(); }
\ No newline at end of file |