Add: Added Javadoc For "toStringBoard" Method In CavePaintings.java.

2026-04-30 16:41:14 +02:00
parent 1af39bc558
commit 3c0ea0f9eb
3 changed files with 36 additions and 14 deletions
@@ -89,13 +89,19 @@ public class CavePaintings extends EventCard {

    /**
     * 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: {@code NLower}, {@code NUpper}, {@code NPrestigeRem} and {@code NPrestigeMul}.
+     * toString to print a more detailed version.
+     * <p>NOTE: {@code NUpper} is not a real attribute used in calculations (only {@code NLower} is needed),
+     * however it's a parameter on the cards' design.
+     * </p>
+     * <p>includes:
+     * <li>{@link #NLower}
+     * <li>{@code NUpper}
+     * <li>{@link #NPrestigeRem}
+     * <li>{@link #NPrestigeMul}
+     * </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 #NLower
-     * @see #NPrestigeRem
-     * @see #NPrestigeMul
     */
    @Override
    public String toStringBoard() {