Add JavaDoc comments to view interfaces

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@62 72836036-5685-4462-b002-a69064685172

1 files changed, 23 insertions, 0 deletions

diff --git a/src/jrummikub/view/IClickable.java b/src/jrummikub/view/IClickable.java
index 9973d5b..818e4fa 100644
--- a/src/jrummikub/view/IClickable.java
+++ b/src/jrummikub/view/IClickable.java
@@ -4,9 +4,32 @@ import jrummikub.model.Position;
 import jrummikub.util.IEvent2;
 
 public interface IClickable {
+  /**
+   * the click event is emitted when the player clicks on the table/board/etc.
+   * 
+   * @return the event; the first parameter is the position of the click in grid
+   *         coordinates, the second is true when the player wants to add stones
+   *         to his selection instead of replacing them
+   */
   public IEvent2<Position, Boolean> getClickEvent();
 
+  /**
+   * the range click event is emitted when the player clicks on the table/board/
+   * etc. and wants to select a range instead of a single stone
+   * 
+   * @return the event; the first parameter is the position of the click in grid
+   *         coordinates, the second is true when the player wants to add stones
+   *         to his selection instead of replacing them
+   */
   public IEvent2<Position, Boolean> getRangeClickEvent();
 
+  /**
+   * the set click event is emitted when the player clicks on the table/board/
+   * etc. and wants to select a whole set instead of a single stone
+   * 
+   * @return the event; the first parameter is the position of the click in grid
+   *         coordinates, the second is true when the player wants to add stones
+   *         to his selection instead of replacing them
+   */
   public IEvent2<Position, Boolean> getSetClickEvent();
 }