More view JavaDoc

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

src/jrummikub/util/Pair.java

@@ -2,20 +2,34 @@ package jrummikub.util;
 
 /**
  * A pair of objects
+ * @param <T1> the first type of the pair
+ * @param <T2> the second type of the pair
  */
 public class Pair<T1, T2> {
-  final T1 first;
-  final T2 second;
+  private final T1 first;
+  private final T2 second;
 
+  /**
+   * Create a new pair
+   * 
+   * @param first the first value
+   * @param second the second value
+   */
   public Pair(T1 first, T2 second) {
     this.first = first;
     this.second = second;
   }
 
+  /**
+   * @return the first value
+   */
   public T1 getFirst() {
     return first;
   }
 
+  /**
+   * @return the first value
+   */
   public T2 getSecond() {
     return second;
   }

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

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.

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();
 

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 {
 }

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

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