Added: JAVADOC html in deliverables

This commit is contained in:
rubenpirreram
2026-06-19 23:09:49 +02:00
parent 1b155e7056
commit db65e0a8be
222 changed files with 55370 additions and 25 deletions
@@ -110,12 +110,13 @@ public class CavePaintings extends EventCard {
* <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>
* Includes:
* <ul>
* <li>{@link #nLower}</li>
* <li>{@code NUpper}</li>
* <li>{@link #nPrestigeRem}</li>
* <li>{@link #nPrestigeMul}</li>
* </ul>
* @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
@@ -130,10 +130,11 @@ public class ShamanicRitual 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.
* <p>Includes:
* <li>{@link #prestigeToAdd}
* <li>{@link #prestigeToRemove}
* </p>
* Includes:
* <ul>
* <li>{@link #prestigeToAdd}</li>
* <li>{@link #prestigeToRemove}</li>
* </ul>
* @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
@@ -111,9 +111,10 @@ public class Sustenance 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.
* <p>Includes:
* <li>{@link #prestigeDebt}
* </p>
* Includes:
* <ul>
* <li>{@link #prestigeDebt}</li>
* </ul>
* @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
@@ -79,7 +79,6 @@ public class Player implements Serializable {
case GATHERER -> gatherers.size();
};
}
/**
* The current {@link BuildingCard Building Cards} in the player's deck.
*/
@@ -157,6 +156,8 @@ public class Player implements Serializable {
return prestigeValue;
}
/**
* Adds {@code value} amount of Food to the Player.
* @param value The amount of Food to be added. Should be non-negative.
@@ -242,6 +243,7 @@ public class Player implements Serializable {
this.totem = null;
}
/**
* Checks equality between this {@code Player} and another object.
* Two players are equal if and only if they share the same {@code userName}.
@@ -264,17 +266,18 @@ public class Player implements Serializable {
/**
* Prints the {@code Player}'s attributes for the {@code Board}'s representation.
* Uses the {@code UNICODE} border style.
* <p><b>Includes:</b>
* <li>{@link #foodValue Food}
* <li>{@link #prestigeValue Prestige}
* <li>{@link #artists Artists}
* <li>{@link #builders Builders}
* <li>{@link #gatherers Gatherers}
* <li>{@link #shamans Shamans}
* <li>{@link #inventors Inventors}
* <li>{@link #hunters Hunters}
* <li>{@link #buildingCards Buildings}
* </p>
* <b>Includes:</b>
* <ul>
* <li>{@link #foodValue Food}</li>
* <li>{@link #prestigeValue Prestige}</li>
* <li>{@link #artists Artists}</li>
* <li>{@link #builders Builders}</li>
* <li>{@link #gatherers Gatherers}</li>
* <li>{@link #shamans Shamans}</li>
* <li>{@link #inventors Inventors}</li>
* <li>{@link #hunters Hunters}</li>
* <li>{@link #buildingCards Buildings}</li>
* </ul>
* @return {@code String} - A string representation of the {@code Player}'s attributes.
* @see it.polimi.ingsw.gc14.View.TUI.BorderStyle BorderStyle
*/