hoo2/Snake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Small comment changes for doxygen

Browse Source
This commit is contained in:
Christos Houtouridis 2018-11-11 18:56:14 +02:00
parent f89d442dcc
commit 46137acf3c
6 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/net/hoo2/auth/dsproject/snake/Apple.java
View File

@ -10,7 +10,7 @@ import java.lang.Math;
* Each apple have a point contribution to the user and can be eaten once * Each apple have a point contribution to the user and can be eaten once
* The point system is algebraic in order to simplify calculation. * The point system is algebraic in order to simplify calculation.
* *
* @author Christos Choutouridis 8997 * @author Christos Choutouridis AEM:8997
* @email cchoutou@ece.auth.gr * @email cchoutou@ece.auth.gr
*/ */
public class Apple { public class Apple {

4
src/net/hoo2/auth/dsproject/snake/Board.java
View File

@ -11,11 +11,11 @@ import java.lang.Math;
* and apples which we called elements are placed on the board * and apples which we called elements are placed on the board
* for each game. * for each game.
* *
* @author Christos Choutouridis 8997 * @author Christos Choutouridis AEM:8997
* @email cchoutou@ece.auth.gr * @email cchoutou@ece.auth.gr
*/ */
public class Board { public class Board {
/** Constants */ /** @name Constants */
/**@{ */ /**@{ */
static final int POINTS_MAX = 20; /**< The maximum absolute number of points for each apple */ static final int POINTS_MAX = 20; /**< The maximum absolute number of points for each apple */
static final int POINTS_STEP = 5; /**< The difference between different apple points */ static final int POINTS_STEP = 5; /**< The difference between different apple points */

16
src/net/hoo2/auth/dsproject/snake/Game.java
View File

@ -10,7 +10,7 @@ package net.hoo2.auth.dsproject.snake;
* * All member functions * * All member functions
* * All data members * * All data members
* *
* @author Christos Choutouridis 8997 * @author Christos Choutouridis AEM:8997
* @email cchoutou@ece.auth.gr * @email cchoutou@ece.auth.gr
*/ */
@ -25,24 +25,24 @@ import java.util.ArrayList;
* This class includes the main function.Using this class's api * This class includes the main function.Using this class's api
* the user can create a board, register players and roll the game. * the user can create a board, register players and roll the game.
* *
* @author Christos Choutouridis 8997 * @author Christos Choutouridis AEM:8997
* @email cchoutou@ece.auth.gr * @email cchoutou@ece.auth.gr
*/ */
public class Game { public class Game {
/** Constants */ /** @name Constants */
/**@{ */ /**@{ */
static final int MAX_PLAYERS = 4; /**< The maximum number of allowed players in the game */ static final int MAX_PLAYERS = 4; /**< The maximum number of allowed players in the game */
static final int MAX_GAME_ROUNDS = 10000; /**< the maximum allowed round of the game */ static final int MAX_GAME_ROUNDS = 10000; /**< the maximum allowed round of the game */
/**@} */ /**@} */
/** Private data members */ /** @name Private data members */
/** @{ */ /** @{ */
private int round; /**< The current round of the game */ private int round; /**< The current round of the game */
private Board board; /**< A reference to board */ private Board board; /**< A reference to board */
private ArrayList<Player> players; /**< A reference to players */ private ArrayList<Player> players; /**< A reference to players */
/** @} */ /** @} */
/** private api */ /** @name private api */
/** @{ */ /** @{ */
/** /**
* Dice functionality * Dice functionality
@ -68,7 +68,7 @@ public class Game {
/** @} */ /** @} */
/** Constructors */ /** @name Constructors */
/** @{ */ /** @{ */
/** Default doing nothing constructor */ /** Default doing nothing constructor */
Game () { Game () {
@ -95,7 +95,7 @@ public class Game {
} }
/** @} */ /** @} */
/** Get/Set interface */ /** @name Get/Set interface */
/** @{ */ /** @{ */
int getRound () { return round; } int getRound () { return round; }
void setRound (int round) { this.round = round; } void setRound (int round) { this.round = round; }
@ -120,7 +120,7 @@ public class Game {
} }
/** @} */ /** @} */
/** Public functionality */ /** @name Public functionality */
/** @{ */ /** @{ */
/** /**
* Register a player to the game * Register a player to the game

2
src/net/hoo2/auth/dsproject/snake/Ladder.java
View File

@ -7,7 +7,7 @@ package net.hoo2.auth.dsproject.snake;
* Ladders are part of the elements we place on the board. * Ladders are part of the elements we place on the board.
* They help the user to elevate rows. Each ladder can be used only once. * They help the user to elevate rows. Each ladder can be used only once.
* *
* @author Christos Choutouridis 8997 * @author Christos Choutouridis AEM:8997
* @email cchoutou@ece.auth.gr * @email cchoutou@ece.auth.gr
*/ */
public class Ladder { public class Ladder {

2
src/net/hoo2/auth/dsproject/snake/Player.java
View File

@ -7,7 +7,7 @@ package net.hoo2.auth.dsproject.snake;
* The players are playing in a round-robin sequence and we keep track * The players are playing in a round-robin sequence and we keep track
* for each one of them their playing order, score and place on the board. * for each one of them their playing order, score and place on the board.
* *
* @author Christos Choutouridis 8997 * @author Christos Choutouridis AEM:8997
* @email cchoutou@ece.auth.gr * @email cchoutou@ece.auth.gr
*/ */
public class Player { public class Player {

2
src/net/hoo2/auth/dsproject/snake/Snake.java
View File

@ -7,7 +7,7 @@ package net.hoo2.auth.dsproject.snake;
* Snakes are part of the elements we place on the board and they add * Snakes are part of the elements we place on the board and they add
* difficulty to the game. * difficulty to the game.
* *
* @author Christos Choutouridis 8997 * @author Christos Choutouridis AEM:8997
* @email cchoutou@ece.auth.gr * @email cchoutou@ece.auth.gr
*/ */
public class Snake { public class Snake {