diff --git a/src/main/java/edu/rpi/legup/app/Config.java b/src/main/java/edu/rpi/legup/app/Config.java index edaabc5f1..adae8459a 100644 --- a/src/main/java/edu/rpi/legup/app/Config.java +++ b/src/main/java/edu/rpi/legup/app/Config.java @@ -64,7 +64,7 @@ public List 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 = ""; diff --git a/src/main/java/edu/rpi/legup/model/Puzzle.java b/src/main/java/edu/rpi/legup/model/Puzzle.java index f64fc5bb6..5139d7654 100644 --- a/src/main/java/edu/rpi/legup/model/Puzzle.java +++ b/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 algorithm) { public boolean checkValidity() { return true; } -} \ No newline at end of file +} diff --git a/src/main/java/edu/rpi/legup/puzzle/nurikabe/elements/NumberTile.java b/src/main/java/edu/rpi/legup/puzzle/nurikabe/elements/NumberTile.java index 3b576983b..0b1ee9656 100644 --- a/src/main/java/edu/rpi/legup/puzzle/nurikabe/elements/NumberTile.java +++ b/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; diff --git a/src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersBoard.java b/src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersBoard.java index 8d9e13166..a8fc3170b 100644 --- a/src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersBoard.java +++ b/src/main/java/edu/rpi/legup/puzzle/skyscrapers/SkyscrapersBoard.java @@ -51,28 +51,28 @@ public ArrayList 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 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 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 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 getNorthClues() { return northClues; diff --git a/src/main/java/edu/rpi/legup/puzzle/sudoku/elements/NumberTile.java b/src/main/java/edu/rpi/legup/puzzle/sudoku/elements/NumberTile.java index 1331e93ee..e3159d87c 100644 --- a/src/main/java/edu/rpi/legup/puzzle/sudoku/elements/NumberTile.java +++ b/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; diff --git a/src/main/java/edu/rpi/legup/ui/ScrollView.java b/src/main/java/edu/rpi/legup/ui/ScrollView.java index d49f9207c..8f9144fda 100644 --- a/src/main/java/edu/rpi/legup/ui/ScrollView.java +++ b/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) { diff --git a/src/main/java/edu/rpi/legup/ui/WrapLayout.java b/src/main/java/edu/rpi/legup/ui/WrapLayout.java index 79771d2a4..ab8cddea4 100644 --- a/src/main/java/edu/rpi/legup/ui/WrapLayout.java +++ b/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 - * visible 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 diff --git a/src/main/java/edu/rpi/legup/ui/lookandfeel/materialdesign/DropShadowBorder.java b/src/main/java/edu/rpi/legup/ui/lookandfeel/materialdesign/DropShadowBorder.java index 0d3a2a5d6..2543b8664 100644 --- a/src/main/java/edu/rpi/legup/ui/lookandfeel/materialdesign/DropShadowBorder.java +++ b/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 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;