From d2705a70e86e3446b9c0d4ee77a628f07465ff81 Mon Sep 17 00:00:00 2001 From: rubenpirreram Date: Wed, 22 Apr 2026 16:00:18 +0200 Subject: [PATCH] Fix:JavaDoc Format --- .../Model/Cards/Building/Effects/Building0.java | 16 ++++++++-------- .../Model/Cards/Building/Effects/Building1.java | 14 +++++++------- .../Model/Cards/Building/Effects/Building4.java | 16 ++++++++-------- .../Model/Cards/Building/Effects/Building8.java | 12 ++++++------ 4 files changed, 29 insertions(+), 29 deletions(-) diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building0.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building0.java index 9ae8e89..4dc0a38 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building0.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building0.java @@ -25,9 +25,9 @@ public class Building0 extends BuildingCard { /** * Constructor of the building - * @param era the game era 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 era The game era 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. */ public Building0(int era,int price,int 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. - * @param player the player who buys the building - * @return the outcome of the operation + * @param player The player who buys the building. + * @return The outcome of the operation. */ @Override 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. * 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) { @@ -73,7 +73,7 @@ public class Building0 extends BuildingCard { /** * 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 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). * 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. */ @Override diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building1.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building1.java index 9dce61c..cdf7261 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building1.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building1.java @@ -20,16 +20,16 @@ public class Building1 extends BuildingCard { 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;} /** - * Constructor of the building - * @param era the game era 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 icon the character type used by the building effect + * Constructor of the building. + * @param era The game era 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 icon The character type used by the building effect. */ public Building1(int era, int price,int prestigeValue, CharacterType icon) { super(era,price,prestigeValue); @@ -40,7 +40,7 @@ public class Building1 extends BuildingCard { /** * 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 public BuildingCard clone() { diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building4.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building4.java index 3ff9a83..60e4d2f 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building4.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building4.java @@ -25,9 +25,9 @@ public class Building4 extends BuildingCard { /** * Constructor of the building - * @param era the game era 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 era The game era 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. */ public Building4(int era, int price,int 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. - * @param player the player who buys the building - * @return the outcome of the operation + * @param player The player who buys the building. + * @return The outcome of the operation. */ @Override public boolean buy(Player player) @@ -80,7 +80,7 @@ public class Building4 extends BuildingCard { /** * 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 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). * The player gains an amount of food equal to 3 times this result. - * @param player the player who owns the building - * @throws IllegalArgumentException thrown if the specified player does not own this card. + * @param player The player who owns the building. + * @throws IllegalArgumentException Thrown if the specified player does not own this card. */ @Override public void applyEffect(Player player) throws IllegalArgumentException { diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building8.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building8.java index 86509a1..d67017d 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building8.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/Building/Effects/Building8.java @@ -13,9 +13,9 @@ public class Building8 extends BuildingCard { /** * Constructor of the building - * @param era the game era 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 era The game era 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. */ public Building8(int era, int price,int prestigeValue) { super(era,price,prestigeValue); @@ -25,7 +25,7 @@ public class Building8 extends BuildingCard { /** * 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 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. - * @param player the player who owns the building - * @throws IllegalArgumentException thrown if the specified player does not own this building. + * @param player The player who owns the building. + * @throws IllegalArgumentException Thrown if the specified player does not own this building. */ @Override public void applyEffect(Player player) throws IllegalArgumentException {