Update checkstyle version to v8.32 (#41)

As the checkstyle version is 3 years out of date, let's update the
version to the latest available to benefit from the improvements.

Let's
* Replace deprecated checks.
* Move LineLength check out of TreeWalker.
* Add check for invalid JavaDoc position.
* Fix checkstyle violations in existing code.

Author: j-lum

build.gradle

@@ -16,7 +16,7 @@ repositories {
 }
 
 checkstyle {
-    toolVersion = '8.1'
+    toolVersion = '8.29'
 }
 
 test {

config/checkstyle/checkstyle.xml

@@ -29,13 +29,14 @@
     <property name="file" value="${config_loc}/suppressions.xml"/>
   </module>
 
+  <module name="LineLength">
+    <!-- Checks if a line is too long. -->
+    <property name="max" value="120"/>
+  </module>
 
   <!-- All Java AST specific tests live under TreeWalker module. -->
   <module name="TreeWalker">
 
-    <!-- Required for SuppressionCommentFilter to work -->
-    <module name="FileContentsHolder"/>
-
     <!-- Required to allow exceptions in code style -->
     <module name="SuppressionCommentFilter">
       <property name="offCommentFormat" value="CHECKSTYLE.OFF\: ([\w\|]+)"/>
@@ -158,11 +159,6 @@
     <!-- Checks if a catch block is empty and does not contain any comments. -->
     <module name="EmptyCatchBlock"/>
 
-    <module name="LineLength">
-      <!-- Checks if a line is too long. -->
-      <property name="max" value="120"/>
-    </module>
-
     <module name="LeftCurly">
       <!-- Checks for placement of the left curly brace ('{'). -->
       <property name="severity" value="warning"/>
@@ -387,37 +383,20 @@
 
     <!-- Checks that every public method (excluding getters, setters and constructors) has a header comment. -->
     <module name="JavadocMethod">
-      <!-- Checks public methods that have more than 1 line of code.
-        Single line of code methods are often due to refactor for readability.
-      -->
-      <property name="minLineCount" value="1"/>
       <property name="allowedAnnotations" value="Override, Test, BeforeAll, BeforeEach, AfterAll, AfterEach, Subscribe"/>
       <property name="scope" value="public"/>
-      <property name="allowUndeclaredRTE" value="true"/>
-      <property name="allowThrowsTagsForSubclasses" value="true"/>
+      <property name="validateThrows" value="false"/>
       <property name="allowMissingParamTags" value="true"/>
-      <property name="allowMissingThrowsTags" value="true"/>
       <property name="allowMissingReturnTag" value="true"/>
-      <property name="allowMissingPropertyJavadoc" value="true"/>
-      <property name="ignoreMethodNamesRegex" value="(set.*|get.*)"/>
       <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF"/>
     </module>
-    <!-- Checks that every non-trivial private method (excluding getters, setters and constructors) has a header comment. -->
-    <module name="JavadocMethod">
-      <!-- Checks private methods that have more than 3 lines of code.
-        We define methods that have more than 3 lines of code as non-trivial.
-      -->
-      <property name="minLineCount" value="3"/>
-      <property name="allowedAnnotations" value="Override, Test, BeforeAll, BeforeEach, AfterAll, AfterEach, Subscribe"/>
-      <property name="scope" value="private"/>
-      <property name="allowUndeclaredRTE" value="true"/>
-      <property name="allowThrowsTagsForSubclasses" value="true"/>
-      <property name="allowMissingParamTags" value="true"/>
-      <property name="allowMissingThrowsTags" value="true"/>
-      <property name="allowMissingReturnTag" value="true"/>
+
+    <module name="InvalidJavadocPosition"/>
+
+    <module name="MissingJavadocMethodCheck">
+      <property name="minLineCount" value="1"/>
       <property name="allowMissingPropertyJavadoc" value="true"/>
       <property name="ignoreMethodNamesRegex" value="(set.*|get.*)"/>
-      <property name="tokens" value="METHOD_DEF, ANNOTATION_FIELD_DEF"/>
     </module>
 
   </module>

config/checkstyle/suppressions.xml

@@ -6,4 +6,5 @@
 
 <suppressions>
   <suppress checks="JavadocType" files=".*Test\.java"/>
+  <suppress checks="MissingJavadocMethodCheck" files=".*Test\.java"/>
 </suppressions>

src/main/java/seedu/address/commons/core/GuiSettings.java

@@ -17,12 +17,18 @@ public class GuiSettings implements Serializable {
     private final double windowHeight;
     private final Point windowCoordinates;
 
+    /**
+     * Constructs a {@code GuiSettings} with the default height, width and position.
+     */
     public GuiSettings() {
         windowWidth = DEFAULT_WIDTH;
         windowHeight = DEFAULT_HEIGHT;
         windowCoordinates = null; // null represent no coordinates
     }
 
+    /**
+     * Constructs a {@code GuiSettings} with the specified height, width and position.
+     */
     public GuiSettings(double windowWidth, double windowHeight, int xPosition, int yPosition) {
         this.windowWidth = windowWidth;
         this.windowHeight = windowHeight;

src/main/java/seedu/address/commons/core/Version.java

@@ -22,6 +22,9 @@ public class Version implements Comparable<Version> {
     private final int patch;
     private final boolean isEarlyAccess;
 
+    /**
+     * Constructs a {@code Version} with the given version details.
+     */
     public Version(int major, int minor, int patch, boolean isEarlyAccess) {
         this.major = major;
         this.minor = minor;

src/main/java/seedu/address/commons/util/AppUtil.java

@@ -10,6 +10,9 @@
  */
 public class AppUtil {
 
+    /**
+     * Gets an {@code Image} from the specified path.
+     */
     public static Image getImage(String imagePath) {
         requireNonNull(imagePath);
         return new Image(MainApp.class.getResourceAsStream(imagePath));

src/main/java/seedu/address/logic/LogicManager.java

@@ -28,6 +28,9 @@ public class LogicManager implements Logic {
     private final Storage storage;
     private final AddressBookParser addressBookParser;
 
+    /**
+     * Constructs a {@code LogicManager} with the given {@code Model} and {@code Storage}.
+     */
     public LogicManager(Model model, Storage storage) {
         this.model = model;
         this.storage = storage;

src/main/java/seedu/address/storage/StorageManager.java

@@ -20,7 +20,9 @@ public class StorageManager implements Storage {
     private AddressBookStorage addressBookStorage;
     private UserPrefsStorage userPrefsStorage;
 
-
+    /**
+     * Creates a {@code StorageManager} with the given {@code AddressBookStorage} and {@code UserPrefStorage}.
+     */
     public StorageManager(AddressBookStorage addressBookStorage, UserPrefsStorage userPrefsStorage) {
         super();
         this.addressBookStorage = addressBookStorage;

src/main/java/seedu/address/ui/CommandBox.java

@@ -21,6 +21,9 @@ public class CommandBox extends UiPart<Region> {
     @FXML
     private TextField commandTextField;
 
+    /**
+     * Creates a {@code CommandBox} with the given {@code CommandExecutor}.
+     */
     public CommandBox(CommandExecutor commandExecutor) {
         super(FXML);
         this.commandExecutor = commandExecutor;

src/main/java/seedu/address/ui/MainWindow.java

@@ -50,6 +50,9 @@ public class MainWindow extends UiPart<Stage> {
     @FXML
     private StackPane statusbarPlaceholder;
 
+    /**
+     * Creates a {@code MainWindow} with the given {@code Stage} and {@code Logic}.
+     */
     public MainWindow(Stage primaryStage, Logic logic) {
         super(FXML, primaryStage);
 

src/main/java/seedu/address/ui/PersonCard.java

@@ -41,6 +41,9 @@ public class PersonCard extends UiPart<Region> {
     @FXML
     private FlowPane tags;
 
+    /**
+     * Creates a {@code PersonCode} with the given {@code Person} and index to display.
+     */
     public PersonCard(Person person, int displayedIndex) {
         super(FXML);
         this.person = person;

src/main/java/seedu/address/ui/PersonListPanel.java

@@ -20,6 +20,9 @@ public class PersonListPanel extends UiPart<Region> {
     @FXML
     private ListView<Person> personListView;
 
+    /**
+     * Creates a {@code PersonListPanel} with the given {@code ObservableList}.
+     */
     public PersonListPanel(ObservableList<Person> personList) {
         super(FXML);
         personListView.setItems(personList);

src/main/java/seedu/address/ui/StatusBarFooter.java

@@ -17,7 +17,9 @@ public class StatusBarFooter extends UiPart<Region> {
     @FXML
     private Label saveLocationStatus;
 
-
+    /**
+     * Creates a {@code StatusBarFooter} with the given {@code Path}.
+     */
     public StatusBarFooter(Path saveLocation) {
         super(FXML);
         saveLocationStatus.setText(Paths.get(".").resolve(saveLocation).toString());

src/main/java/seedu/address/ui/UiManager.java

@@ -25,6 +25,9 @@ public class UiManager implements Ui {
     private Logic logic;
     private MainWindow mainWindow;
 
+    /**
+     * Creates a {@code UiManager} with the given {@code Logic}.
+     */
     public UiManager(Logic logic) {
         super();
         this.logic = logic;

src/test/java/seedu/address/logic/parser/ArgumentTokenizerTest.java

@@ -106,7 +106,7 @@ public void tokenize_multipleArguments() {
         assertPreambleEmpty(argMultimap);
         assertArgumentAbsent(argMultimap, pSlash);
 
-        /** Also covers: testing for prefixes not specified as a prefix **/
+        /* Also covers: testing for prefixes not specified as a prefix */
 
         // Prefixes not previously given to the tokenizer should not return any values
         argsString = unknownPrefix + "some value";

src/test/java/seedu/address/testutil/PersonBuilder.java

@@ -27,6 +27,9 @@ public class PersonBuilder {
     private Address address;
     private Set<Tag> tags;
 
+    /**
+     * Creates a {@code PersonBuilder} with the default details.
+     */
     public PersonBuilder() {
         name = new Name(DEFAULT_NAME);
         phone = new Phone(DEFAULT_PHONE);