Resolved errors and warnings in the Javadoc (#529)

* Update Config.java * Update GameBoardFacade.java * Update ICommand.java * Update ICommand.java * Update ICommand.java * Update Puzzle.java * Update GameBoardFacade.java * Update Config.java * Update GameBoardFacade.java * Update Puzzle.java * Update Puzzle.java * Update Puzzle.java * Update SkyscrapersBoard.java * Update SkyscrapersBoard.java * Update SkyscrapersBoard.java * Update SkyscrapersBoard.java * Update SkyscrapersBoard.java * Update SkyscrapersBoard.java * Update SkyscrapersBoard.java * Update SkyscrapersCellFactory.java * Update PuzzleExporter.java * Update BattleshipCellFactory.java * Update PuzzleExporter.java * Update PuzzleImporter.java * Update PuzzleImporter.java * Update PuzzleImporter.java * Update PuzzleImporter.java * Update PuzzleImporter.java * Update PuzzleImporter.java * Update PuzzleImporter.java * Update PuzzleImporter.java * Update PuzzleImporter.java * Update BattleshipImporter.java * Created descriptions for param node and exception InvalidFileException * Update BattleshipType.java * Update BattleshipType.java * Update BoardView.java * Update GridBoardView.java * Update FillapixCellFactory.java * Update FillapixImporter.java * Update FillapixImporter.java * Update HeyawakeFactory.java * Update HeyawakeImporter.java * Update BattleshipImporter.java * Update HeyawakeImporter.java * Update AutoCaseRuleCommand.java * Update AutoCaseRuleCommand.java * Update ValidateCaseRuleCommand.java * Update LightUpCellFactory.java * Update LightUpImporter.java * Update MasyuCellFactory.java * Update MasyuImporter.java * Update NurikabeCellFactory.java * Update NurikabeImporter.java * Update RulePanel.java * Update RulePanel.java * Update RulePanel.java * Update RulePanel.java * Update RulePanel.java * Update ShortTruthTableCellFactory.java * Update ShortTruthTableCellType.java * Update ShortTruthTableCellType.java * Update ShortTruthTableCellType.java * Update SkyscrapersBoard.java * Update SkyscrapersImporter.java * Update SkyscrapersImporter.java * Update SudokuCell.java * Update SudokuCellFactory.java * Update SudokuImporter.java * Update SudokuImporter.java * Update Tree.java * Update TreeTentCellFactory.java * Update TreeTentImporter.java * Update TreeToolbarPanel.java * Update LegupUI.java * Update WrapLayout.java * Update LegupUtils.java * Update ValidateContradictionRuleCommand.java --------- Co-authored-by: Ivan Ho <41582274 [email protected]> Co-authored-by: Charles Tian <46334090 [email protected]>
Bram-Hub · charlestian23 · May 5, 2023 · Jan 27, 2023 · Jan 27, 2023 · Jan 27, 2023
commit 212b73f0a034d11aaac5c70b0d145509f7dbcc48
diff --git a/src/main/java/edu/rpi/legup/app/Config.java b/src/main/java/edu/rpi/legup/app/Config.java
@@ -25,7  25,7 @@ public class Config {
     /**
      * Config Constructor for logic puzzles
      *
-     * @throws InvalidConfigException
      * @throws InvalidConfigException if configuration is invalid
      */
     public Config() throws InvalidConfigException {
         this.puzzles = new Hashtable<>();

diff --git a/src/main/java/edu/rpi/legup/app/GameBoardFacade.java b/src/main/java/edu/rpi/legup/app/GameBoardFacade.java
@@ -187,6  187,7 @@ public void loadPuzzle(String game, int rows, int columns) throws RuntimeExcepti
      * Loads a puzzle file
      *
      * @param fileName file name of the board file
      * @throws InvalidFileFormatException if input is invalid
      */
     public void loadPuzzle(String fileName) throws InvalidFileFormatException {
         try {
@@ -276,7  277,7 @@ public void loadPuzzleEditor(InputStream inputStream) throws InvalidFileFormatEx
 
     /**
      * Loads a puzzle file from the input stream
-     *
      * @throws InvalidFileFormatException if input is invalid
      * @param inputStream input stream for the puzzle file
      */
     public void loadPuzzle(InputStream inputStream) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/history/AutoCaseRuleCommand.java b/src/main/java/edu/rpi/legup/history/AutoCaseRuleCommand.java
@@ -29,6  29,9 @@ public class AutoCaseRuleCommand extends PuzzleCommand {
      *
      * @param elementView currently selected puzzle puzzleElement view that is being edited
      * @param selection   currently selected tree puzzleElement views that is being edited
      * @param caseRule currently selected caseRule puzzleElement view that is being edited
      * @param caseBoard currently selected caseBoard puzzleElement view that is being edited
      * @param mouseEvent currently selected mouseEvent puzzleElement view that is being edited
      */
     public AutoCaseRuleCommand(ElementView elementView, TreeViewSelection selection, CaseRule caseRule, CaseBoard caseBoard, MouseEvent mouseEvent) {
         this.elementView = elementView;

diff --git a/src/main/java/edu/rpi/legup/history/ICommand.java b/src/main/java/edu/rpi/legup/history/ICommand.java
@@ -2,12  2,13 @@
 
 public interface ICommand {
     /**
-     * Executes an command
      * Executes a command
      */
     void execute();
 
     /**
      * Determines whether this command can be executed
      * @return true if can execute, false otherwise
      */
     boolean canExecute();
 
@@ -20,12  21,12 @@ public interface ICommand {
     String getError();
 
     /**
-     * Undoes an command
      * Undoes a command
      */
     void undo();
 
     /**
-     * Redoes an command
      * Redoes a command
      */
     void redo();
 }
diff --git a/src/main/java/edu/rpi/legup/history/ValidateCaseRuleCommand.java b/src/main/java/edu/rpi/legup/history/ValidateCaseRuleCommand.java
@@ -25,6  25,7 @@ public class ValidateCaseRuleCommand extends PuzzleCommand {
      * AutoCaseRuleCommand Constructor creates a command for verifying a case rule
      *
      * @param selection currently selected tree puzzleElement views that is being edited
      * @param caseRule currently selected caseRule puzzleElement view that is being edited
      */
     public ValidateCaseRuleCommand(TreeViewSelection selection, CaseRule caseRule) {
         this.selection = selection.copy();

diff --git a/src/main/java/edu/rpi/legup/history/ValidateContradictionRuleCommand.java b/src/main/java/edu/rpi/legup/history/ValidateContradictionRuleCommand.java
@@ -22,7  22,7 @@ public class ValidateContradictionRuleCommand extends PuzzleCommand {
      * ValidateContradictionRuleCommand Constructor creates a puzzle command for verifying a contradiction rule
      *
      * @param selection currently selected tree puzzleElement views
-     * @param rule      contradiction rule to set to all of the tree elements
      * @param rule      contradiction rule to be set to all the tree elements
      */
     public ValidateContradictionRuleCommand(TreeViewSelection selection, ContradictionRule rule) {
         this.selection = selection.copy();
@@ -32,7  32,7 @@ public ValidateContradictionRuleCommand(TreeViewSelection selection, Contradicti
     }
 
     /**
-     * Executes an command
      * Executes a command
      */
     @Override
     public void executeCommand() {
@@ -117,7  117,7 @@ public String getErrorString() {
     }
 
     /**
-     * Undoes an command
      * Undoes a command
      */
     @Override
     public void undoCommand() {

diff --git a/src/main/java/edu/rpi/legup/model/Puzzle.java b/src/main/java/edu/rpi/legup/model/Puzzle.java
@@ -248,8  248,8 @@ public boolean isPuzzleComplete() {
     /**
      * Imports the board using the file stream
      *
-     * @param fileName
-     * @throws InvalidFileFormatException
      * @param fileName the file that is imported
      * @throws InvalidFileFormatException if file is invalid
      */
     public void importPuzzle(String fileName) throws InvalidFileFormatException {
         try {
@@ -264,8  264,8 @@ public void importPuzzle(String fileName) throws InvalidFileFormatException {
     /**
      * Imports the board using the file stream
      *
-     * @param inputStream
-     * @throws InvalidFileFormatException
      * @param inputStream the file stream that is imported
      * @throws InvalidFileFormatException if file stream is invalid
      */
     public void importPuzzle(InputStream inputStream) throws InvalidFileFormatException {
         Document document;

diff --git a/src/main/java/edu/rpi/legup/model/PuzzleExporter.java b/src/main/java/edu/rpi/legup/model/PuzzleExporter.java
@@ -26,6  26,7 @@ public abstract class PuzzleExporter {
 
     /**
      * PuzzleExporter Constructor exports the puzzle object to a file
      * @param puzzle puzzle that is to be exported
      */
     public PuzzleExporter(Puzzle puzzle) {
         this.puzzle = puzzle;
@@ -35,7  36,7 @@ public PuzzleExporter(Puzzle puzzle) {
      * Exports the puzzle to an xml formatted file
      *
      * @param fileName name of file to be exported
-     * @throws ExportFileException
      * @throws ExportFileException if puzzle can not be exported
      */
     public void exportPuzzle(String fileName) throws ExportFileException {
         try {

diff --git a/src/main/java/edu/rpi/legup/model/PuzzleImporter.java b/src/main/java/edu/rpi/legup/model/PuzzleImporter.java
@@ -24,6  24,7 @@ public abstract class PuzzleImporter {
 
     /**
      * PuzzleImporter Constructor creates the puzzle object
      * @param puzzle puzzle that is imported
      */
     public PuzzleImporter(Puzzle puzzle) {
         this.puzzle = puzzle;
@@ -34,7  35,7 @@ public PuzzleImporter(Puzzle puzzle) {
      *
      * @param rows    number of rows on the puzzle
      * @param columns number of columns on the puzzle
-     * @throws RuntimeException
      * @throws RuntimeException if puzzle can not be made
      */
     public void initializePuzzle(int rows, int columns) throws RuntimeException {
         if (this.puzzle.isValidDimensions(rows, columns)) {
@@ -49,7  50,7 @@ public void initializePuzzle(int rows, int columns) throws RuntimeException {
      * Initializes the puzzle attributes
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     public void initializePuzzle(Node node) throws InvalidFileFormatException {
         if (node.getNodeName().equalsIgnoreCase("puzzle")) {
@@ -103,23  104,23 @@ public void initializePuzzle(Node node) throws InvalidFileFormatException {
      *
      * @param rows    number of rows on the puzzle
      * @param columns number of columns on the puzzle
-     * @throws RuntimeException
      * @throws RuntimeException if board can not be created
      */
     public abstract void initializeBoard(int rows, int columns);
 
     /**
      * Creates an empty board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     public abstract void initializeBoard(Node node) throws InvalidFileFormatException;
 
     /**
      * Creates the proof for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     public void initializeProof(Node node) throws InvalidFileFormatException {
         if (node.getNodeName().equalsIgnoreCase("proof")) {
@@ -153,6  154,7 @@ public void initializeProof(Node node) throws InvalidFileFormatException {
      * Sets the puzzleElement from the xml document node
      *
      * @param node xml document node
      * @throws InvalidFileFormatException if file is invalid
      */
     protected void setCells(Node node) throws InvalidFileFormatException {
         NodeList dataList = ((org.w3c.dom.Element) node).getElementsByTagName("cell");
@@ -166,8  168,8 @@ protected void setCells(Node node) throws InvalidFileFormatException {
     /**
      * Creates the tree for the edu.rpi.legup.puzzle
      *
-     * @param node
-     * @throws InvalidFileFormatException
      * @param node xml document node
      * @throws InvalidFileFormatException if file is invalid
      */
     protected void createTree(Node node) throws InvalidFileFormatException {
         Element treeElement = (org.w3c.dom.Element) node;

diff --git a/src/main/java/edu/rpi/legup/model/tree/Tree.java b/src/main/java/edu/rpi/legup/model/tree/Tree.java
@@ -101,7  101,7 @@ public Set<TreeElement> getLeafTreeElements() {
 
     /**
      * Gets a Set of TreeNodes that are leaf nodes from the sub tree rooted at the specified node
-     *
      * @param node node that is input
      * @return Set of TreeNodes that are leaf nodes from the sub tree
      */
     public Set<TreeElement> getLeafTreeElements(TreeNode node) {

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipCellFactory.java b/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipCellFactory.java
@@ -17,7  17,7 @@ public class BattleshipCellFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public PuzzleElement<BattleshipType> importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipImporter.java b/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipImporter.java
@@ -18,7  18,7 @@ public BattleshipImporter(Battleship battleShip) {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
      * @throws RuntimeException if board can not be created
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -29,7  29,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipType.java b/src/main/java/edu/rpi/legup/puzzle/battleship/BattleshipType.java
@@ -13,7  13,7 @@ public enum BattleshipType {
 
     /**
      * Gets the enum of this BattleShipType
-     *
      * @param value the integer value input
      * @return enum equivalent BattleShipType of integer value
      */
     public static BattleshipType getType(int value) {

diff --git a/src/main/java/edu/rpi/legup/puzzle/fillapix/FillapixCellFactory.java b/src/main/java/edu/rpi/legup/puzzle/fillapix/FillapixCellFactory.java
@@ -17,7  17,7 @@ public class FillapixCellFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public FillapixCell importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/fillapix/FillapixImporter.java b/src/main/java/edu/rpi/legup/puzzle/fillapix/FillapixImporter.java
@@ -18,7  18,7 @@ public FillapixImporter(Fillapix fillapix) {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
      * @throws RuntimeException if board can not be made
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -29,7  29,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/heyawake/HeyawakeFactory.java b/src/main/java/edu/rpi/legup/puzzle/heyawake/HeyawakeFactory.java
@@ -17,7  17,7 @@ public class HeyawakeFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public HeyawakeCell importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/heyawake/HeyawakeImporter.java b/src/main/java/edu/rpi/legup/puzzle/heyawake/HeyawakeImporter.java
@@ -19,7  19,7 @@ public HeyawakeImporter(Heyawake heyawake) {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
      * @throws RuntimeException if board can not be created
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -30,7  30,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/LightUpCellFactory.java b/src/main/java/edu/rpi/legup/puzzle/lightup/LightUpCellFactory.java
@@ -17,7  17,7 @@ public class LightUpCellFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public LightUpCell importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/lightup/LightUpImporter.java b/src/main/java/edu/rpi/legup/puzzle/lightup/LightUpImporter.java
@@ -18,7  18,7 @@ public LightUpImporter(LightUp lightUp) {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
      * @throws RuntimeException if board can not be created
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -41,7  41,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/masyu/MasyuCellFactory.java b/src/main/java/edu/rpi/legup/puzzle/masyu/MasyuCellFactory.java
@@ -17,7  17,7 @@ public class MasyuCellFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public MasyuCell importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/masyu/MasyuImporter.java b/src/main/java/edu/rpi/legup/puzzle/masyu/MasyuImporter.java
@@ -18,7  18,7 @@ public MasyuImporter(Masyu masyu) {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
      * @throws RuntimeException if board can not be created
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -29,7  29,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/nurikabe/NurikabeCellFactory.java b/src/main/java/edu/rpi/legup/puzzle/nurikabe/NurikabeCellFactory.java
@@ -17,7  17,7 @@ public class NurikabeCellFactory extends ElementFactory {
      * @param node  node that represents the puzzleElement
      * @param board board to add the newly created cell
      * @return newly created cell from the xml document Node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public NurikabeCell importCell(Node node, Board board) throws InvalidFileFormatException {

diff --git a/src/main/java/edu/rpi/legup/puzzle/nurikabe/NurikabeImporter.java b/src/main/java/edu/rpi/legup/puzzle/nurikabe/NurikabeImporter.java
@@ -18,7  18,7 @@ public NurikabeImporter(Nurikabe nurikabe) {
      *
      * @param rows    the number of rows on the board
      * @param columns the number of columns on the board
-     * @throws RuntimeException
      * @throws RuntimeException if board can not be created
      */
     @Override
     public void initializeBoard(int rows, int columns) {
@@ -39,7  39,7 @@ public void initializeBoard(int rows, int columns) {
      * Creates the board for building
      *
      * @param node xml document node
-     * @throws InvalidFileFormatException
      * @throws InvalidFileFormatException if file is invalid
      */
     @Override
     public void initializeBoard(Node node) throws InvalidFileFormatException {