Aleandro/Progetto-ingegneria-del-software
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix: TUI javadoc

Browse Source
This commit is contained in:
rubenpirreram
2026-05-03 18:13:50 +02:00
parent 9bedea3855
commit 04b61a8cb2
1 changed files with 19 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/java/it/polimi/ingsw/gc14/View/TUI/TUI.java
+19 -14
View File
@@ -7,18 +7,18 @@ import java.util.List;
public class TUI implements IView {
/**
* The {@link it.polimi.ingsw.gc14.Model.Game } model stored for the game status render
* The {@link it.polimi.ingsw.gc14.Model.Game } model stored for the game status render.
*/
private Game model;
/**
* The {@link it.polimi.ingsw.gc14.Model.Player } username stored for the player hand render
* The {@link it.polimi.ingsw.gc14.Model.Player } username stored for the player hand render.
*/
private String username;
/**
* Constructor for the class {@code TUI}
* @param model The model that will be display
* Constructor for the class {@code TUI}.
* @param model The model that will be displayed.
*/
public TUI(Game model) {
this.model = model;
@@ -26,7 +26,7 @@ public class TUI implements IView {
}
/**
* Set the {@code Username} of the player, used for the hand player display
* Set the {@code Username} of the player, used for the hand player display.
* @param username
*/
public void setUsername(String username) {
@@ -34,7 +34,7 @@ public class TUI implements IView {
}
/**
* Update {@link it.polimi.ingsw.gc14.Model.Game } model stored for the game status render
* Update {@link it.polimi.ingsw.gc14.Model.Game } model stored for the game status render.
*/
@Override
public void update(Game model) {
@@ -42,7 +42,7 @@ public class TUI implements IView {
}
/**
* Default method called to display homepage , implements {@link IView}
* Default method called to display homepage , implements {@link IView}.
*/
public void render()
{
@@ -50,7 +50,9 @@ public class TUI implements IView {
}
/**
* Method called to display players status and board status
* Method called to display players status and board status.
* In the upper part displays {@link #renderPlayer} information , in a table format.
* In the lower part displays {@link #renderBoard} information in the left , menu options and {@code Username} hand in the right.
*/
public void fullRender()
{
@@ -73,7 +75,8 @@ public class TUI implements IView {
}
/**
* Method called to display board status
* Method called to display board status.
* Displays turn order ,upper list cards , offer track , lower list cards in the left, menu options and {@code Username} hand in the right.
*/
public void renderBoard()
{
@@ -94,7 +97,8 @@ public class TUI implements IView {
System.out.println(AsciiTable.sideBySide(lines,lines2,3));
}
/**
* Method called to display player status
* Method called to display player status.
* Displays player prestige value,food value, character deck and building deck , in a table format.
*/
public void renderPlayer()
{
@@ -116,7 +120,7 @@ public class TUI implements IView {
}
/**
* Method called to display a message on the terminal
* Method called to display a message on the terminal.
*/
public void showMessage(String message)
{
@@ -124,7 +128,7 @@ public class TUI implements IView {
}
/**
* Method called to display a error on the terminal
* Method called to display a error on the terminal.
*/
public void showError(String message)
{
@@ -132,8 +136,9 @@ public class TUI implements IView {
}
/**
* Method used to set up menu options
* @return the string format of the menu options
* Method used to set up menu options.
* List of runnable command as a legend.
* @return the string format of the menu options.
*/
private String PrintMenuOptions()
{