Docs: refine JavaDoc for character card classes

src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Artist.java

@@ -74,7 +74,8 @@ public class Artist extends Character {
     }
 
     /**
-     * Inserts this Artist card into the specified player's Artist collection.
+     * Inserts this Artist card into the specified player's Artist collection
+     * and applies any building effects triggered by character set completion.
      *
      * @param player the player who receives the card.
      */
@@ -85,4 +86,3 @@ public class Artist extends Character {
     }
 
 }
-

src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Builder.java

@@ -143,13 +143,10 @@ public class Builder extends Character {
     }
 
     /**
-     * Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
+     * Returns a detailed string representation of this {@code Builder} card,
-     * toString to print a more detailed version.
+     * including its reduction value and prestige value.
-     * <p>Includes:
+     *
-     * <li>{@link #reductionValue Reduction Value}
+     * @return a detailed string representation of this {@code Builder} card.
-     * <li>{@link #prestigeValue Prestige Value}
-     * </p>
-     * @return {@code String} - a string representation of this {@code TribeCard}.
      * @see it.polimi.ingsw.gc14.Model.Cards.TribeCard TribeCard
      * @see it.polimi.ingsw.gc14.Model.Game Game
      * @see it.polimi.ingsw.gc14.Model.GamePackage.Board Board
@@ -172,7 +169,8 @@ public class Builder extends Character {
     }
 
     /**
-     * Inserts this Builder card into the specified player's Builder collection.
+     * Inserts this Builder card into the specified player's Builder collection
+     * and applies any building effects triggered by character set completion.
      *
      * @param player the player who receives the card.
      */

src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Gatherer.java

@@ -15,7 +15,7 @@ public class Gatherer extends Character {
     /**
      * Creates a Gatherer character card with the specified era.
      *
-     * @param Era Gatherers era.
+     * @param Era the era of the Gatherer card.
      */
     public Gatherer(int Era) {
         super(Era, CharacterType.GATHERER);
@@ -32,7 +32,7 @@ public class Gatherer extends Character {
     }
 
     /**
-     * Creates a Gatherer character card with the specified era.
+     * Creates a Gatherer character card with the specified image id and era.
      *
      * @param idIMG the image identifier of the Gatherer card.
      * @param Era the era of the Gatherer card.
@@ -74,7 +74,8 @@ public class Gatherer extends Character {
     }
 
     /**
-     * Inserts this Gatherer card into the specified player's Gatherer collection.
+     * Inserts this Gatherer card into the specified player's Gatherer collection
+     * and applies any building effects triggered by character set completion.
      *
      * @param player the player who receives the card.
      */

src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Hunter.java

@@ -93,11 +93,14 @@ public class Hunter extends Character {
     }
 
     /**
-     * Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
+     * Returns a detailed string representation of this {@code TribeCard}.
-     * toString to print a more detailed version.
+     * This specific variation is used in the {@code Game}'s
+     * toString to provide a more detailed version.
+     *
      * <p>Potentially includes:
      * <li>{@link #icon Icon}
      * </p>
+     *
      * @return {@code String} - a string representation of this {@code TribeCard}.
      * @see it.polimi.ingsw.gc14.Model.Cards.TribeCard TribeCard
      * @see it.polimi.ingsw.gc14.Model.Game Game
@@ -125,6 +128,10 @@ public class Hunter extends Character {
     /**
      * Inserts this Hunter card into the specified player's Hunter collection.
      *
+     * <p>If this card has the Hunter icon, the player gains 1 food for each
+     * Hunter currently in their tribe. The method also applies any building
+     * effects triggered by character set completion.
+     *
      * @param player the player who receives the card.
      */
     @Override

src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Inventor.java

@@ -97,11 +97,14 @@ public class Inventor extends Character {
     }
 
     /**
-     * Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
+     * Returns a detailed string representation of this {@code TribeCard}.
-     * toString to print a more detailed version.
+     * This specific variation is used in the {@code Game}'s toString
+     * to provide a more detailed version.
+     *
      * <p>Includes:
      * <li>{@link #icon Icons's ID}
      * </p>
+     *
      * @return {@code String} - a string representation of this {@code TribeCard}.
      * @see it.polimi.ingsw.gc14.Model.Cards.TribeCard TribeCard
      * @see it.polimi.ingsw.gc14.Model.Game Game
@@ -125,6 +128,9 @@ public class Inventor extends Character {
     /**
      * Inserts this Inventor card into the specified player's Inventor collection.
      *
+     * <p>The method also applies the building effects related to inventor pairs
+     * and any building effects triggered by character set completion.
+     *
      * @param player the player who receives the card.
      */
     @Override

src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java

@@ -90,8 +90,8 @@ public class Shaman extends Character {
     }
 
     /**
-     * Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
+     * Returns a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s
-     * toString to print a more detailed version.
+     * toString to provide a more detailed version.
      * <p>Includes:
      * <li>{@link #icon Number of stars}
      * </p>
@@ -116,7 +116,8 @@ public class Shaman extends Character {
     }
 
     /**
-     * Inserts this Shaman card into the specified player's Shaman collection.
+     * Inserts this Shaman card into the specified player's Shaman collection
+     * and applies any building effects triggered by character set completion.
      *
      * @param player the player who receives the card.
      */