Javadoc/style improvements

git-svn-id: http://chris.smith.name/svn/japoker/trunk@10 b8598caf-53df-4c1b-98b8-507a84a220

src/com/md87/cardgame/controllers/NetworkPlayer.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) Chris 'MD87' Smith, 2007. All rights reserved.
+ * Copyright (c) Chris 'MD87' Smith, 2007-2008. All rights reserved.
  *
  * This code may not be redistributed without prior permission from the
  * aforementioned copyright holder(s).
@@ -31,128 +31,153 @@ public class NetworkPlayer implements PlayerController, GameObserver {
     }
 
     /** {@inheritDoc} */
+    @Override
     public CallRaiseFold doCallRaiseFold(int callAmount, boolean canRaise) {
         return CallRaiseFold.CALL;
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public OpenCheck doOpenCheck() {
         return OpenCheck.CHECK;
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public boolean shouldShowCards() {
         return false;
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void setPlayer(Player player) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void setGame(Game game) {
         game.registerObserver(this);
     }
 
     /** {@inheritDoc} */
+    @Override
     public int getRaise(int minimum) {
         return minimum;
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void communityCardsUpdated() {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void playerCardsUpdated() {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void playersTurn(Player player) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void newPlayer(Player player) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void newGame() {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void endGame() {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void setDealer(Player player) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void placeBlind(Player player, int blind, String name) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void raise(Player player, int amount) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void fold(Player player) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void call(Player player) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void check(Player player) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void open(Player player, int amount) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void winner(Player players) {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public void showdown() {
         // Do nothing
     }
 
     /** {@inheritDoc} */
+    @Override
     public boolean isLocalHuman() {
         return false;
     }
     
     /** {@inheritDoc} */
+    @Override
     public Deck discardCards(final int minimum, final int maximum) {
         return new Deck();
     }
 
+    @Override
     public void discards(Player player, int number) {
         // Do nothing
     }
 
+    @Override
     public void cardDealt(Player player, Card card) {
         // Do nothing
     }

src/com/md87/cardgame/interfaces/GameObserver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) Chris 'MD87' Smith, 2007. All rights reserved.
+ * Copyright (c) Chris 'MD87' Smith, 2007-2008. All rights reserved.
  *
  * This code may not be redistributed without prior permission from the
  * aforementioned copyright holder(s).
@@ -11,23 +11,56 @@ import com.md87.cardgame.Card;
 import com.md87.cardgame.Player;
 
 /**
- *
+ * The main interface for objects that wish to observe game events as they
+ * happen.
+ * 
  * @author Chris
  */
 public interface GameObserver {
 
+    /**
+     * Called when the community cards have been updated.
+     */
     void communityCardsUpdated();
     
+    /**
+     * Called when the players' hole cards have been updated.
+     * 
+     * @deprecated Behaviour should be done in cardDealt instead
+     */
+    @Deprecated
     void playerCardsUpdated();
     
+    /**
+     * Called when a card is dealt to the specified player.
+     * 
+     * @param player The player the card is being dealt to
+     * @param card The card that was dealt
+     */
     void cardDealt(final Player player, final Card card);
     
+    /**
+     * Called at the start of a player's turn.
+     * 
+     * @param player The player whose turn it is now
+     */
     void playersTurn(final Player player);
     
+    /**
+     * Called when a new player enters the game.
+     * 
+     * @param player The player that has joined
+     */
     void newPlayer(final Player player);
     
+    /**
+     * Called at the start of a game.
+     */
     void newGame();
     
+    /**
+     * Called at the end of a game.
+     */
     void endGame();
     
     void setDealer(final Player player);