[ictk-cvs] ictk/src/ictk/boardgame/chess/net/ics/event ICSBoardUpdateEvent.java,1.3,1.4 ICSHistoryEvent.java,1.2,1.3 ICSMoveListEvent.java,1.5,1.6

[<jva...@us...>]

Update of /cvsroot/ictk/ictk/src/ictk/boardgame/chess/net/ics/event
In directory sc8-pr-cvs1:/tmp/cvs-serv31943/src/ictk/boardgame/chess/net/ics/event

Modified Files:
	ICSBoardUpdateEvent.java ICSHistoryEvent.java 
	ICSMoveListEvent.java 
Log Message:
Updated docs about new features and build file to do distribution and hints
about deleting generated source files.


Index: ICSBoardUpdateEvent.java
===================================================================
RCS file: /cvsroot/ictk/ictk/src/ictk/boardgame/chess/net/ics/event/ICSBoardUpdateEvent.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** ICSBoardUpdateEvent.java	23 Aug 2003 09:08:10 -0000	1.3
--- ICSBoardUpdateEvent.java	1 Oct 2003 06:37:18 -0000	1.4
***************
*** 27,38 ****
--- 27,51 ----
  import ictk.boardgame.chess.net.ics.*;
  
+ /* ICSBoardUpdateEvent ******************************************************/
+ /** A board representation that indicates the client should update the
+  *  local representation of the board.  An example of this is Sytle12.
+  */
  public class ICSBoardUpdateEvent extends ICSEvent 
                                            implements ICSBoardEvent {
+ 
     public static final int EVENT_TYPE = ICSEvent.BOARD_UPDATE_EVENT;
+ 
+       /** this is an isolated position the user is looking at.  This
+        ** arrises as a result of "ref 3" or the "sposition" command */
     public static final int ISO_POSITION_RELATION = -3,
+       /** this is a game being examined that the user is observing */
                             OBSERVING_EXAMINED_RELATION = -2,
+       /** this is a game the user is observing */
  			   EXAMINING_RELATION = 2,
+       /** this is a game the user is playing but it is not his move */
  			   PLAYING_NOT_MY_MOVE_RELATION = -1,
+       /** this is a game the user is playing and it is his move */
  			   PLAYING_MY_MOVE_RELATION = 1,
+       /** this is a game being played that the user is observing */
  			   OBSERVING_PLAY_RELATION = 0;
                             
***************
*** 51,55 ****
                   boardNumber,
  		 moveNumber,
! /*** my relation to this game:
      -3 isolated position, such as for "ref 3" or the "sposition" command
      -2 I am observing game being examined
--- 64,69 ----
                   boardNumber,
  		 moveNumber,
! 
! /** my relation to this game:
      -3 isolated position, such as for "ref 3" or the "sposition" command
      -2 I am observing game being examined
***************
*** 189,192 ****
--- 203,208 ----
  
     ////////////////////////////////////////////////////////////////////////
+    /** this is completely temporary and only for diagnostic purposes.
+     */
     public String getReadable () {
        StringBuffer sb = new StringBuffer(80);
***************
*** 237,240 ****
        return getReadable();
     }
- 
  }
--- 253,255 ----

Index: ICSHistoryEvent.java
===================================================================
RCS file: /cvsroot/ictk/ictk/src/ictk/boardgame/chess/net/ics/event/ICSHistoryEvent.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** ICSHistoryEvent.java	13 May 2003 16:01:39 -0000	1.2
--- ICSHistoryEvent.java	1 Oct 2003 06:37:18 -0000	1.3
***************
*** 29,32 ****
--- 29,36 ----
  import java.io.IOException;
  
+ /* ICSHistoryEvent **********************************************************/
+ /** A history of games played by a particular user.  This is the result
+  *  of the "history" command.
+  */
  public class ICSHistoryEvent extends ICSEvent {
     //static///////////////////////////////////////////////////////////////
***************
*** 49,55 ****
     public void setHistoryList (ICSGameInfo[] l) { list = l; }
  
     public String getReadable () {
        return "History List";
     }
- 
  }
--- 53,60 ----
     public void setHistoryList (ICSGameInfo[] l) { list = l; }
  
+    /** doesn't do much yet.
+     */
     public String getReadable () {
        return "History List";
     }
  }

Index: ICSMoveListEvent.java
===================================================================
RCS file: /cvsroot/ictk/ictk/src/ictk/boardgame/chess/net/ics/event/ICSMoveListEvent.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** ICSMoveListEvent.java	24 Aug 2003 07:16:35 -0000	1.5
--- ICSMoveListEvent.java	1 Oct 2003 06:37:18 -0000	1.6
***************
*** 31,34 ****
--- 31,38 ----
  import java.util.Calendar;
  
+ /* ICSMoveListEvent *********************************************************/
+ /** A list of moves from a game.  This is the result of the commands:
+  *  "moves" or "smoves".
+  */
  public class ICSMoveListEvent extends ICSEvent 
                                implements ICSBoardEvent{