Fix:JavaDoc Format
This commit is contained in:
@@ -25,9 +25,9 @@ public class Building0 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructor of the building
|
* Constructor of the building
|
||||||
* @param era the game era of the building
|
* @param era The game era of the building.
|
||||||
* @param price the price (in food) of the building
|
* @param price The price (in food) of the building.
|
||||||
* @param prestigeValue the number of Prestige Points gained from this building at the end of the game
|
* @param prestigeValue The number of Prestige Points gained from this building at the end of the game.
|
||||||
*/
|
*/
|
||||||
public Building0(int era,int price,int prestigeValue) {
|
public Building0(int era,int price,int prestigeValue) {
|
||||||
super(era,price,prestigeValue);
|
super(era,price,prestigeValue);
|
||||||
@@ -39,8 +39,8 @@ public class Building0 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Method used to purchase the building. It also handles its initialization.
|
* Method used to purchase the building. It also handles its initialization.
|
||||||
* @param player the player who buys the building
|
* @param player The player who buys the building.
|
||||||
* @return the outcome of the operation
|
* @return The outcome of the operation.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public boolean buy(Player player)
|
public boolean buy(Player player)
|
||||||
@@ -54,7 +54,7 @@ public class Building0 extends BuildingCard {
|
|||||||
/**
|
/**
|
||||||
* Initializes the building by counting the number of complete sets at the moment of purchase.
|
* Initializes the building by counting the number of complete sets at the moment of purchase.
|
||||||
* The building can only be initialized once.
|
* The building can only be initialized once.
|
||||||
* @param player the player who owns the building, whose cards are counted to determine the number of sets.
|
* @param player The player who owns the building, whose cards are counted to determine the number of sets.
|
||||||
*/
|
*/
|
||||||
public void initialize(Player player)
|
public void initialize(Player player)
|
||||||
{
|
{
|
||||||
@@ -73,7 +73,7 @@ public class Building0 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Method to clone the building: it creates an exact copy.
|
* Method to clone the building: it creates an exact copy.
|
||||||
* @return the new copy of the building
|
* @return The new copy of the building
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public BuildingCard clone() {
|
public BuildingCard clone() {
|
||||||
@@ -83,7 +83,7 @@ public class Building0 extends BuildingCard {
|
|||||||
/**
|
/**
|
||||||
* Calculates the current number of card sets and subtracts the previous value (i.e., the number of newly obtained sets).
|
* Calculates the current number of card sets and subtracts the previous value (i.e., the number of newly obtained sets).
|
||||||
* The player gains an amount of food equal to 5 times this result.
|
* The player gains an amount of food equal to 5 times this result.
|
||||||
* @param player the player who owns the building
|
* @param player The player who owns the building.
|
||||||
* @throws IllegalArgumentException thrown if the specified player does not own this card.
|
* @throws IllegalArgumentException thrown if the specified player does not own this card.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
|
|||||||
@@ -20,16 +20,16 @@ public class Building1 extends BuildingCard {
|
|||||||
private CharacterType icon ;
|
private CharacterType icon ;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @return the character type associated with this building effect
|
* @return The character type associated with this building effect.
|
||||||
*/
|
*/
|
||||||
public CharacterType getIcon() {return icon;}
|
public CharacterType getIcon() {return icon;}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructor of the building
|
* Constructor of the building.
|
||||||
* @param era the game era of the building
|
* @param era The game era of the building.
|
||||||
* @param price the price (in food) of the building
|
* @param price The price (in food) of the building.
|
||||||
* @param prestigeValue the number of Prestige Points gained from this building at the end of the game
|
* @param prestigeValue The number of Prestige Points gained from this building at the end of the game.
|
||||||
* @param icon the character type used by the building effect
|
* @param icon The character type used by the building effect.
|
||||||
*/
|
*/
|
||||||
public Building1(int era, int price,int prestigeValue, CharacterType icon) {
|
public Building1(int era, int price,int prestigeValue, CharacterType icon) {
|
||||||
super(era,price,prestigeValue);
|
super(era,price,prestigeValue);
|
||||||
@@ -40,7 +40,7 @@ public class Building1 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Method to clone the building: it creates an exact copy.
|
* Method to clone the building: it creates an exact copy.
|
||||||
* @return the new copy of the building
|
* @return The new copy of the building.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public BuildingCard clone() {
|
public BuildingCard clone() {
|
||||||
|
|||||||
@@ -25,9 +25,9 @@ public class Building4 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructor of the building
|
* Constructor of the building
|
||||||
* @param era the game era of the building
|
* @param era The game era of the building.
|
||||||
* @param price the price (in food) of the building
|
* @param price The price (in food) of the building.
|
||||||
* @param prestigeValue the number of Prestige Points gained from this building at the end of the game
|
* @param prestigeValue The number of Prestige Points gained from this building at the end of the game.
|
||||||
*/
|
*/
|
||||||
public Building4(int era, int price,int prestigeValue) {
|
public Building4(int era, int price,int prestigeValue) {
|
||||||
super(era,price,prestigeValue);
|
super(era,price,prestigeValue);
|
||||||
@@ -66,8 +66,8 @@ public class Building4 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Method used to purchase the building. It also handles its initialization.
|
* Method used to purchase the building. It also handles its initialization.
|
||||||
* @param player the player who buys the building
|
* @param player The player who buys the building.
|
||||||
* @return the outcome of the operation
|
* @return The outcome of the operation.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public boolean buy(Player player)
|
public boolean buy(Player player)
|
||||||
@@ -80,7 +80,7 @@ public class Building4 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Method to clone the building: it creates an exact copy.
|
* Method to clone the building: it creates an exact copy.
|
||||||
* @return the new copy of the building
|
* @return The new copy of the building.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public BuildingCard clone() {
|
public BuildingCard clone() {
|
||||||
@@ -90,8 +90,8 @@ public class Building4 extends BuildingCard {
|
|||||||
/**
|
/**
|
||||||
* Calculates the current number of pairs and subtracts the previous value (i.e., the number of newly obtained pairs).
|
* Calculates the current number of pairs and subtracts the previous value (i.e., the number of newly obtained pairs).
|
||||||
* The player gains an amount of food equal to 3 times this result.
|
* The player gains an amount of food equal to 3 times this result.
|
||||||
* @param player the player who owns the building
|
* @param player The player who owns the building.
|
||||||
* @throws IllegalArgumentException thrown if the specified player does not own this card.
|
* @throws IllegalArgumentException Thrown if the specified player does not own this card.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public void applyEffect(Player player) throws IllegalArgumentException {
|
public void applyEffect(Player player) throws IllegalArgumentException {
|
||||||
|
|||||||
@@ -13,9 +13,9 @@ public class Building8 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Constructor of the building
|
* Constructor of the building
|
||||||
* @param era the game era of the building
|
* @param era The game era of the building.
|
||||||
* @param price the price (in food) of the building
|
* @param price The price (in food) of the building.
|
||||||
* @param prestigeValue the number of Prestige Points gained from this building at the end of the game
|
* @param prestigeValue The number of Prestige Points gained from this building at the end of the game.
|
||||||
*/
|
*/
|
||||||
public Building8(int era, int price,int prestigeValue) {
|
public Building8(int era, int price,int prestigeValue) {
|
||||||
super(era,price,prestigeValue);
|
super(era,price,prestigeValue);
|
||||||
@@ -25,7 +25,7 @@ public class Building8 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Method to clone the building: it creates an exact copy.
|
* Method to clone the building: it creates an exact copy.
|
||||||
* @return the new copy of the building
|
* @return The new copy of the building.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public BuildingCard clone() {
|
public BuildingCard clone() {
|
||||||
@@ -34,8 +34,8 @@ public class Building8 extends BuildingCard {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* For each builder in the player's hand, the player gains double the Prestige Point indicated on the builder card.
|
* For each builder in the player's hand, the player gains double the Prestige Point indicated on the builder card.
|
||||||
* @param player the player who owns the building
|
* @param player The player who owns the building.
|
||||||
* @throws IllegalArgumentException thrown if the specified player does not own this building.
|
* @throws IllegalArgumentException Thrown if the specified player does not own this building.
|
||||||
*/
|
*/
|
||||||
@Override
|
@Override
|
||||||
public void applyEffect(Player player) throws IllegalArgumentException {
|
public void applyEffect(Player player) throws IllegalArgumentException {
|
||||||
|
|||||||
Reference in New Issue
Block a user