fix: fixed errors and warnings of Javadocs

Author: S0NN1

src/main/java/it/polimi/ingsw/client/Cell.java

@@ -35,7 +35,7 @@ public int getWorkerNum() {
      * Method setWorkerNum sets the workerNum of this Cell object.
      *
      * @param workerNum of type int - the workerNum of this Cell object.
-     * @throws IllegalArgumentException when if workerNum <0 || workerNum>2.
+     * @throws IllegalArgumentException when if workerNum &lt;0 || workerNum&gt;2.
      */
     public void setWorkerNum(int workerNum) throws IllegalArgumentException {   //0 -> no worker; 1 -> worker n1;
         // 2 -> worker n2

src/main/java/it/polimi/ingsw/client/ClientBoard.java

@@ -178,6 +178,7 @@ private void setWorkerNumColors(
    * @param row of type int - the row of the selected row.
    * @param col of type int - the column of the selected column.
    * @param dome of type boolean true if worker wants to build a dome instead of a block. (Only for Atlas workers)
+   * @param action of type Action - the type of action.
    */
   public void build(int row, int col, boolean dome, Action action) {
     if(!action.equals(Action.BUILD)){

src/main/java/it/polimi/ingsw/client/ConnectionSocket.java

@@ -50,6 +50,7 @@ public ConnectionSocket() {
    * @param modelView of type ModelView - the structure, stored into the client, containing simple
    *     logic of the model.
    * @param actionHandler of type ActionHandler - the class handling the answers.
+   * @return boolean true if connection is successful, false otherwise.
    * @throws DuplicateNicknameException when the nickname is already in use.
    * @throws InvalidNicknameException when the nickname contains illegal characters (like "-").
    */

src/main/java/it/polimi/ingsw/client/InputChecker.java

@@ -48,7 +48,7 @@ public InputChecker(ConnectionSocket connection, ModelView modelView) {
 
 
     /**
-     * Method desc validates a "GODDESC <god-name>" message type.
+     * Method desc validates a "GODDESC &lt;god-name&gt;" message type.
      *
      * @param in of type String[] - the user input under array representation.
      * @return ChallengerPhaseAction - the correct ChallengerPhaseAction, null otherwise.
@@ -66,7 +66,7 @@ public ChallengerPhaseAction desc(String[] in) {
     }
 
     /**
-     * Method addGod validates an "ADDGOD <god-name>" message type.
+     * Method addGod validates an "ADDGOD &lt;god-name&gt;" message type.
      *
      * @param in of type String[] - the user input under array representation.
      * @return ChallengerPhaseAction - the correct ChallengerPhaseAction, null otherwise.
@@ -84,7 +84,7 @@ public ChallengerPhaseAction addGod(String[] in) {
 
 
     /**
-     * Method choose validates a "CHOOSE <god-name>" message type.
+     * Method choose validates a "CHOOSE &lt;god-name&gt;" message type.
      *
      * @param in of type String[] - the user input under array representation.
      * @return ChallengerPhaseAction - the correct ChallengerPhaseAction, null otherwise.
@@ -102,7 +102,7 @@ public ChallengerPhaseAction choose(String[] in) {
     }
 
     /**
-     * Method starter validates a "STARTER <player-number>" message type.
+     * Method starter validates a "STARTER &lt;player-number&gt;" message type.
      *
      * @param in of type String[] - the user input under array representation.
      * @return ChallengerPhaseAction - the correct ChallengerPhaseAction, null otherwise.
@@ -120,7 +120,7 @@ public ChallengerPhaseAction starter(String[] in) {
     }
 
     /**
-     * Method set validates a "SET <x1> <y1> <x2> <y2>" worker placement message type.
+     * Method set validates a "SET &lt;x1&gt; &lt;y1&gt; &lt;x2&gt; &lt;y2&gt;" worker placement message type.
      *
      * @param in of type String[] - the user input under array representation.
      * @return ChallengerPhaseAction - the correct ChallengerPhaseAction, null otherwise.

src/main/java/it/polimi/ingsw/client/ModelView.java

@@ -75,7 +75,7 @@ public void setGodDesc(String godDesc) {
      *
      *
      *
-     * @param playerMapColor the playerMapColor (type Map<String, String>) of this ModelView object.
+     * @param playerMapColor the playerMapColor (type Maps&lt;String, String&gt;) of this ModelView object.
      *
      */
     public void setPlayerMapColor(Map<String, String> playerMapColor) {
@@ -87,7 +87,7 @@ public void setPlayerMapColor(Map<String, String> playerMapColor) {
      *
      *
      *
-     * @param playerMapGod the playerMapColor (type Map<String, String>) of this ModelView object.
+     * @param playerMapGod the playerMapColor (type Maps&lt;String, String&gt;) of this ModelView object.
      *
      */
     public void setPlayerMapGod(Map<String, String> playerMapGod) {
@@ -99,7 +99,7 @@ public void setPlayerMapGod(Map<String, String> playerMapGod) {
      *
      *
      *
-     * @return the playerMapColor (type Map<String, String>) of this ModelView object.
+     * @return the playerMapColor (type Maps&lt;String, String&gt;) of this ModelView object.
      */
     public Map<String, String> getPlayerMapColor() {
         return playerMapColor;
@@ -110,7 +110,7 @@ public Map<String, String> getPlayerMapColor() {
      *
      *
      *
-     * @return the playerMapGod (type Map<String, String>) of this ModelView object.
+     * @return the playerMapGod (type Maps&lt;String, String&gt;) of this ModelView object.
      */
     public Map<String, String> getPlayerMapGod() {
         return playerMapGod;
@@ -121,7 +121,7 @@ public Map<String, String> getPlayerMapGod() {
      *
      *
      *
-     * @return the selectSpaces (type List<Couple>) of this ModelView object.
+     * @return the selectSpaces (type List&lt;Couple&gt;) of this ModelView object.
      */
     public List<Couple> getSelectSpaces() {
         return selectSpaces;
@@ -132,7 +132,7 @@ public List<Couple> getSelectSpaces() {
      *
      *
      *
-     * @param selectSpaces the selectSpaces(type List<Couple>) of this ModelView object.
+     * @param selectSpaces the selectSpaces(type List&lt;Couple&gt;) of this ModelView object.
      *
      */
     public void setSelectSpaces(List<Couple> selectSpaces) {

src/main/java/it/polimi/ingsw/client/cli/CLI.java

@@ -274,6 +274,7 @@ private String[] generateRows(int level, String[] levels) {
      * @param color of type String - the worker's color.
      * @param rows of type String[] - the rows used to insert player.
      * @param level of type int - the level modified.
+     * @param type of type int - the type of worker.
      */
     private void addWorkerToCell(String color, String[] rows, int level, int type) {
         String[] temp = new String[3];
@@ -338,7 +339,7 @@ private int getRightIndex(boolean b, int i2, int i3) {
      *
      * @param temp   of type String[] - temporary cell's rows in which player is inserted.
      * @param player of type String[] - the player to be inserted into the rows.
-     * @return HashMap<Integer, String [ ]> - the two strings.
+     *@return HashMaps&lt;Integer, String[]&gt; - the two strings.
      */
     private HashMap<Integer, String[]> createStringMap(String[] temp, String[] player) {
         HashMap<Integer, String[]> stringMap = new HashMap<>();
@@ -353,7 +354,7 @@ private HashMap<Integer, String[]> createStringMap(String[] temp, String[] playe
      * @param color of type String  - the player's color
      * @param rows of type String[] - the cell's row
      * @param cellInfos of type int[] - the grid's levels
-     * @param stringMap of type HashMap<Integer, String[]> - the hashmap mapping levels to correct strings.
+     * @param stringMap of type HashMap&lt;Integer, String[]&gt; - the hashmap mapping levels to correct strings.
      * @param indexes of type int[][] - the indexes for each level.
      * @param backgroundColor of type String - the worker's background color.
      * @param counters of type int[] - the indexes in order to print correctly.
@@ -544,6 +545,7 @@ private String[] buildSideHelp() {
      * Method addScores adds spaces to side menu.
      *
      * @param max of type int - max length of side menu.
+     * @param s of type String - the String provided.
      * @return StringBuilder - the string added to side menu.
      */
     private StringBuilder addSpaces(int max, String s) {
@@ -605,7 +607,7 @@ public void choosePlayerNumber() {
      * Method chooseColor lets the player decide his color, relying on the available ones.
      * If the player is the last in a three-players match, the server automatically assign him the last color.
      *
-     * @param available of type List<PlayerColors> - the list of available colors, which will be printed out.
+     * @param available of type List&lt;PlayerColors&gt; - the list of available colors, which will be printed out.
      */
     public void chooseColor(List<PlayerColors> available) {
         firstBuildBoard(grid);
@@ -628,7 +630,7 @@ public void chooseColor(List<PlayerColors> available) {
     }
 
     /**
-     * Method greaterThan prints ">".
+     * Method greaterThan prints "&gt;".
      */
     private void greaterThan() {
         System.out.print(">");

src/main/java/it/polimi/ingsw/client/gui/controllers/GodsPanelController.java

@@ -35,9 +35,9 @@ public void showGod(ActionEvent event) {
 
     /**
      * Method chooseInit initializes the god panel for user's choosing action. It creates the buttons "Choose" and
-     * "Close" and prepares the command "CHOOSE <god-name>" to be sent to the server.
+     * "Close" and prepares the command "CHOOSE &lt;god-name&gt;" to be sent to the server.
      *
-     * @param cards of type List<Card> - the deck of cards.
+     * @param cards of type List&lt;Card&gt; - the deck of cards.
      */
     public void chooseInit(List<Card> cards) {
         for(int i=0; i<3; i++){

src/main/java/it/polimi/ingsw/client/gui/controllers/LoaderController.java

@@ -79,7 +79,7 @@ public boolean godTile(Card god, boolean isChoosing) {
 
     /**
      * Method workerPlacement lists all workers' available positions and make him choose the preferred one.
-     * @param coords of type List<int[]> - the available coordinates.
+     * @param coords of type List&lt;int[]&gt; - the available coordinates.
      */
     public void workerPlacement(List<int[]> coords) {
         gui.getModelView().activateInput();
@@ -241,7 +241,7 @@ public void requestPlayerNumber(String message){
     /**
      * Method requestColor lets each user choose his workers' color, however, in a match of 3 players the last one
      * receives the remaining color.
-     * @param colors of type List<PlayerColors> - the available colors.
+     * @param colors of type List&lt;PlayerColors&gt; - the available colors.
      */
     public void requestColor(List<PlayerColors> colors) {
         Alert alert = new Alert(Alert.AlertType.CONFIRMATION);

src/main/java/it/polimi/ingsw/client/gui/controllers/MainGuiController.java

@@ -210,6 +210,7 @@ public void selectWorker() {
    * @param row of type int - the row of the cell.
    * @param col of type int - the column of the cell.
    * @param dome of type boolean - true if user wants to build a dome, false otherwise.
+   * @param action of type Action - the type of action.
    */
   public void build(int row, int col, boolean dome, Action action) {
     if (!action.equals(Action.BUILD)) {
@@ -484,12 +485,17 @@ public void setGui(GUI gui) {
   /**
    * Method getColors returns the colors of this MainGuiController object.
    *
-   * @return the colors (type HashMap<String, Color>) of this MainGuiController object.
+   * @return the colors (type HashMap&lt;String, Color&gt;) of this MainGuiController object.
    */
   public Map<String, Color> getColors() {
     return colors;
   }
 
+  /**
+   * Method workerPlacement displays worker placement.
+   *
+   * @param coords of type List&lt;int[]&gt; - the coords received.
+   */
   public void workerPlacement(List<int[]> coords) {
     gui.getModelView().activateInput();
     String[] set =new String[2];

src/main/java/it/polimi/ingsw/constants/Constants.java

@@ -76,7 +76,7 @@ private Constants() {}
      *
      *
      *
-     * @return the godMapCustomAction (type HashMap<String, String>) of this Constants object.
+     * @return the godMapCustomAction (type HashMaps&lt;String, String&gt;) of this Constants object.
      */
     public static Map<String, String> getGodMapCustomAction() {
         return godMapCustomAction;
@@ -88,7 +88,7 @@ public static Map<String, String> getGodMapCustomAction() {
      *
      *
      *
-     * @return the specialBuildGods (type List<String>) of this Constants object.
+     * @return the specialBuildGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getSpecialBuildGods() {
         return SPECIAL_BUILD_GODS;
@@ -101,7 +101,7 @@ public static List<String> getSpecialBuildGods() {
      *
      *
      *
-     * @return the endActionGods (type List<String>) of this Constants object.
+     * @return the endActionGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getEndActionGods() {
         return END_ACTION_GODS;
@@ -115,7 +115,7 @@ public static List<String> getEndActionGods() {
      *
      *
      *
-     * @return the startActionGods (type List<String>) of this Constants object.
+     * @return the startActionGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getStartActionGods() {
         return START_ACTION_GODS;
@@ -128,7 +128,7 @@ public static List<String> getStartActionGods() {
      *
      *
      *
-     * @return the buildSameBlockGods (type List<String>) of this Constants object.
+     * @return the buildSameBlockGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getBuildSameBlockGods() {
         return BUILD_SAME_BLOCK_GODS;
@@ -141,7 +141,7 @@ public static List<String> getBuildSameBlockGods() {
      *
      *
      *
-     * @return the doubleMoveGods (type List<String>) of this Constants object.
+     * @return the doubleMoveGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getDoubleMoveGods() {
         return DOUBLE_MOVE_GODS;
@@ -154,7 +154,7 @@ public static List<String> getDoubleMoveGods() {
      *
      *
      *
-     * @return the alternatePhaseGods (type List<String>) of this Constants object.
+     * @return the alternatePhaseGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getAlternatePhaseGods() { return ALTERNATE_PHASE_GODS; }
 
@@ -165,7 +165,7 @@ public static List<String> getDoubleMoveGods() {
      *
      *
      *
-     * @return the doubleBuildGods (type List<String>) of this Constants object.
+     * @return the doubleBuildGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getDoubleBuildGods() {
         return DOUBLE_BUILD_GODS;
@@ -181,7 +181,7 @@ public static List<String> getDoubleBuildGods() {
      *
      *
      *
-     * @return the movePhaseGods (type List<String>) of this Constants object.
+     * @return the movePhaseGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getMovePhaseGods() {
         return MOVE_PHASE_GODS;
@@ -196,7 +196,7 @@ public static List<String> getMovePhaseGods() {
      *
      *
      *
-     * @return the buildPhaseGods (type List<String>) of this Constants object.
+     * @return the buildPhaseGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getBuildPhaseGods() {
         return BUILD_PHASE_GODS;
@@ -212,7 +212,7 @@ public static List<String> getBuildPhaseGods() {
      *
      *
      *
-     * @return the moveToCellOccupiedGods (type List<String>) of this Constants object.
+     * @return the moveToCellOccupiedGods (type List&lt;String&gt;) of this Constants object.
      */
     public static List<String> getMoveToCellOccupiedGods() {
         return MOVE_TO_CELL_OCCUPIED_GODS;