More view JavaDoc

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

6 files changed, 19 insertions, 1 deletions

diff --git a/src/jrummikub/view/IBoard.java b/src/jrummikub/view/IBoard.java
index 0816937..1424dff 100644
--- a/src/jrummikub/view/IBoard.java
+++ b/src/jrummikub/view/IBoard.java
@@ -5,6 +5,9 @@ import java.util.Map;
 import jrummikub.model.Position;
 import jrummikub.model.Stone;
 
+/**
+ * The view for a player's board that displayed his stones
+ */
 public interface IBoard extends IClickable {
   /**
    * Set the player's stones to display on the board
diff --git a/src/jrummikub/view/IClickable.java b/src/jrummikub/view/IClickable.java
index 818e4fa..c827042 100644
--- a/src/jrummikub/view/IClickable.java
+++ b/src/jrummikub/view/IClickable.java
@@ -3,6 +3,9 @@ package jrummikub.view;
 import jrummikub.model.Position;
 import jrummikub.util.IEvent2;
 
+/**
+ * An interface for view elements that can emit click events
+ */
 public interface IClickable {
   /**
    * the click event is emitted when the player clicks on the table/board/etc.
diff --git a/src/jrummikub/view/IPlayerPanel.java b/src/jrummikub/view/IPlayerPanel.java
index 4cddfa4..e39ab65 100644
--- a/src/jrummikub/view/IPlayerPanel.java
+++ b/src/jrummikub/view/IPlayerPanel.java
@@ -2,9 +2,12 @@ package jrummikub.view;
 
 import jrummikub.util.IEvent;
 
+/**
+ * The player panel that contains a player's board and other user interfaces
+ */
 public interface IPlayerPanel {
   /**
-   * @return
+   * @return the board where the players hand stones are displayed
    */
   public IBoard getBoard();
 
diff --git a/src/jrummikub/view/IStoneCollection.java b/src/jrummikub/view/IStoneCollection.java
index 2ef9c79..8b4148d 100644
--- a/src/jrummikub/view/IStoneCollection.java
+++ b/src/jrummikub/view/IStoneCollection.java
@@ -1,4 +1,7 @@
 package jrummikub.view;
 
+/**
+ * The view of the collection that shows the stones a player has selected
+ */
 public interface IStoneCollection extends IClickable {
 }
diff --git a/src/jrummikub/view/ITable.java b/src/jrummikub/view/ITable.java
index 258263a..e257d26 100644
--- a/src/jrummikub/view/ITable.java
+++ b/src/jrummikub/view/ITable.java
@@ -5,6 +5,9 @@ import java.util.Map;
 import jrummikub.model.Position;
 import jrummikub.model.StoneSet;
 
+/**
+ * The view of the table, where the stone sets lie
+ */
 public interface ITable extends IClickable {
   /**
    * Sets the player name on the left label
diff --git a/src/jrummikub/view/IView.java b/src/jrummikub/view/IView.java
index 419a2c1..25ebb32 100644
--- a/src/jrummikub/view/IView.java
+++ b/src/jrummikub/view/IView.java
@@ -4,6 +4,9 @@ import java.util.Collection;
 
 import jrummikub.model.Stone;
 
+/**
+ * The top-level view interface
+ */
 public interface IView {
   /**
    * Returns the table