Issue 513 (#517)

* Revert "Update PuzzleEditorPanel.java"

* Update SkyscrapersBoard.java

* input and updated descriptions for @return and @throws

* Update Puzzle.java

* Update ScrollView.java

* Update WrapLayout.java

* Update NumberTile.java

* Update DropShadowBorder.java

* Erased irrelevant code

* Update Puzzle.java

---------

Co-authored-by: Charles Tian <[email protected]>
Co-authored-by: Ivan Ho <[email protected]>

src/main/java/edu/rpi/legup/app/Config.java

@@ -64,7 +64,7 @@ public List<String> getFileCreationEnabledPuzzles() {
      * convertClassNameToDisplayName("Nurikabe") will return "Nurikabe"
      *
      * @param className the name of the class
-     * @return
+     * @return displayName the name of the puzzle
      */
     public static String convertClassNameToDisplayName(String className) {
         String displayName = "";

src/main/java/edu/rpi/legup/model/Puzzle.java

@@ -249,9 +249,7 @@ public boolean isPuzzleComplete() {
      * Imports the board using the file stream
      *
      * @param fileName
-     * @throws IOException
-     * @throws ParserConfigurationException
-     * @throws SAXException
+     * @throws InvalidFileFormatException
      */
     public void importPuzzle(String fileName) throws InvalidFileFormatException {
         try {
@@ -267,9 +265,7 @@ public void importPuzzle(String fileName) throws InvalidFileFormatException {
      * Imports the board using the file stream
      *
      * @param inputStream
-     * @throws IOException
-     * @throws ParserConfigurationException
-     * @throws SAXException
+     * @throws InvalidFileFormatException
      */
     public void importPuzzle(InputStream inputStream) throws InvalidFileFormatException {
         Document document;
@@ -647,4 +643,4 @@ public void notifyTreeListeners(Consumer<? super ITreeListener> algorithm) {
     public boolean checkValidity() {
         return true;
     }
-}
+}

src/main/java/edu/rpi/legup/puzzle/nurikabe/elements/NumberTile.java

@@ -19,7 +19,6 @@ public int getTileNumber() {
 
     /**
      * @param num Amount to set tile object to.
-     * @return none
      */
     public void setTileNumber(int num) {
         object_num = num;

src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersBoard.java

@@ -51,28 +51,28 @@ public ArrayList<SkyscrapersLine> getLines() {
     }
 
     /**
-     * Returns a list of the eastern clues ordered from loc.y = 0->max
-     */
+    * Returns a list of the eastern clues ordered from loc.y = 0 to max
+    */
     public ArrayList<SkyscrapersClue> getEastClues() {
         return eastClues;
     }
 
     /**
-     * Returns a list of the southern clues ordered from loc.x = 0->max
+     * Returns a list of the southern clues ordered from loc.x = 0 to max
      */
     public ArrayList<SkyscrapersClue> getSouthClues() {
         return southClues;
     }
 
     /**
-     * Returns a list of the western clues ordered from loc.y = 0->max
+     * Returns a list of the western clues ordered from loc.y = 0 to max
      */
     public ArrayList<SkyscrapersClue> getWestClues() {
         return westClues;
     }
 
     /**
-     * Returns a list of the northern clues ordered from loc.x = 0->max
+     * Returns a list of the northern clues ordered from loc.x = 0 to max
      */
     public ArrayList<SkyscrapersClue> getNorthClues() {
         return northClues;

src/main/java/edu/rpi/legup/puzzle/sudoku/elements/NumberTile.java

@@ -19,7 +19,6 @@ public int getTileNumber() {
 
     /**
      * @param num Amount to set tile object to.
-     * @return none
      */
     public void setTileNumber(int num) {
         object_num = num;

src/main/java/edu/rpi/legup/ui/ScrollView.java

@@ -131,7 +131,7 @@ public void updatePosition(Point point, double magnification) {
     /**
      * Zooms in or out on a position within the dynamicView
      *
-     * @param n     level of zoom - n < 0 is zoom in, n > 0 is zoom out
+     * @param n     level of zoom - n less than 0 is zoom in, n greater than 0 is zoom out
      * @param point position to zoom in on
      */
     public void zoom(int n, Point point) {

src/main/java/edu/rpi/legup/ui/WrapLayout.java

@@ -49,7 +49,7 @@ public WrapLayout(int align, int hgap, int vgap) {
 
     /**
      * Returns the preferred dimensions for this layout given the
-     * <image>visible</image> components in the specified target container.
+     * visible components in the specified target container.
      *
      * @param target the component which needs to be laid out
      * @return the preferred dimensions to lay out the

src/main/java/edu/rpi/legup/ui/lookandfeel/materialdesign/DropShadowBorder.java

@@ -68,7 +68,7 @@ public DropShadowBorder(Color lineColor, int lineWidth, int shadowSize,
     }
 
     /**
-     * @inheritDoc
+     *
      */
     public void paintBorder(Component c, Graphics graphics, int x, int y, int width, int height) {
         /*
@@ -289,7 +289,7 @@ private Map<Position, BufferedImage> getImages(Graphics2D g2) {
     }
 
     /**
-     * @inheritDoc
+     *
      */
     public Insets getBorderInsets(Component c) {
         int top = 4 + (showTopShadow ? lineWidth + shadowSize : lineWidth);
@@ -301,7 +301,7 @@ public Insets getBorderInsets(Component c) {
     }
 
     /**
-     * @inheritDoc
+     *
      */
     public boolean isBorderOpaque() {
         return true;