From d0027463d18d487c6fe849b13b0d43d3fefc6f4c Mon Sep 17 00:00:00 2001 From: GabrieleRadice <265572328+GabrieleRadice@users.noreply.github.com> Date: Thu, 30 Apr 2026 17:33:14 +0200 Subject: [PATCH] Add: Added Javadoc For "toStringBoard" Method And "icon" Field In Shaman.java. --- .../Cards/TribeCards/Characters/Shaman.java | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java index 10b3360..d529f2a 100644 --- a/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java +++ b/src/main/java/it/polimi/ingsw/gc14/Model/Cards/TribeCards/Characters/Shaman.java @@ -7,6 +7,14 @@ import it.polimi.ingsw.gc14.Model.Player; public class Shaman extends Character { + + /** + * The number of star {@code Icons} the card possesses. + * During the {@link it.polimi.ingsw.gc14.Model.Cards.TribeCards.Events.ShamanicRitual Shamanic Ritual Event}, having the + * majority of these icons provides Prestige Points; + * having the minority, on the other hand, results in + * losing Prestige Points. + */ private int icon; /** @@ -51,12 +59,22 @@ public class Shaman extends Character { public String toString() { return super.toString() + " *:" + String.valueOf(icon); } + + /** + * Prints a string representation of this {@code TribeCard}. This specific variation is used in the {@code Game}'s + * toString to print a more detailed version. + *

Includes: + *

  • {@link #icon Number of stars} + *

    + * @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 + */ @Override public String toStringBoard() { return super.toStringBoard() + " *:" + String.valueOf(icon); } - /** * Creates and returns a copy of this Shaman card. *