Merge branch 'lenient-checkstyle' into 'main'

fix: A More Chill CheckStyle

Closes #15 and #17

See merge request cse1105/2025-2026/teams/csep-team-76!20

checkstyle.xml

@@ -4,8 +4,10 @@
 	"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
 	"https://checkstyle.org/dtds/configuration_1_3.dtd">
 <module name="Checker">
+	<module name="SuppressionFilter">
+    	<property name="file" value="suppressions.xml"/>
+	</module>
 	<!-- CheckStyle settings -->
-
 	<module name="TreeWalker">
         <!-- 1. camelCase for identifiers -->
 		<module name="LocalVariableName">
@@ -67,6 +69,7 @@
 			<property name="ignoreHashCodeMethod" value="false"/>
 			<property name="ignoreAnnotation" value="true"/>
 			<property name="ignoreFieldDeclaration" value="false"/>
+			<!-- Note: affected by /suppressions.xml -->
 		</module>
 
 		<!-- 9: Check parameter number at most 6 -->
@@ -80,13 +83,13 @@
 			where applicable. -->
 			<property name="processJavadoc" value="true"/>
 		</module>
+		<!-- 11. Prevent invalid JavaDoc strings from passing CI --> 
+		<module name="JavadocStyle"/>
 	</module>
-
-	<!-- 11. File tabs/spaces: require no raw tabs etc -->
+	<!-- 12. File tabs/spaces: require no raw tabs etc -->
 	<module name="FileTabCharacter">
         <property name="severity" value="warning" />
 		<property name="eachLine" value="true"/>
 	</module>
 	
-
 </module>

client/src/main/java/client/scenes/FoodpalApplicationCtrl.java

@@ -212,7 +212,7 @@ public class FoodpalApplicationCtrl implements LocaleAware {
         alert.showAndWait();
     }
     /**
-     * Adds a recipe, by providing a default name "Untitled recipe (n)"
+     * Adds a recipe, by providing a default name "Untitled recipe (n)".
      * The UX flow is now:
      * <ol>
      *     <li>User creates an untitled recipe</li>
@@ -262,8 +262,8 @@ public class FoodpalApplicationCtrl implements LocaleAware {
     }
 
     /**
-     * Revised edit recipe control flow, deprecates the use of a separate AddNameCtrl
-     * This is automagically called when a new recipe is created, making for a more seamless UX
+     * Revised edit recipe control flow, deprecates the use of a separate AddNameCtrl.
+     * This is automagically called when a new recipe is created, making for a more seamless UX.
      */
     @FXML
     private void editRecipeTitle() {
@@ -309,7 +309,7 @@ public class FoodpalApplicationCtrl implements LocaleAware {
     }
 
     /**
-     * Clones a recipe, when clicking on the button "clone"
+     * Clones a recipe, when clicking on the button "clone".
      */
     public void cloneRecipe() throws IOException, InterruptedException {
         Recipe selected = recipeList.getSelectionModel().getSelectedItem();

client/src/main/java/client/utils/ServerUtils.java

@@ -31,7 +31,7 @@ public class ServerUtils {
     }
 
     /**
-     * Gets all the recipes from the backend
+     * Gets all the recipes from the backend.
      * @return a JSON string with all the recipes
      */
     public List<Recipe> getRecipes() throws IOException, InterruptedException {
@@ -51,7 +51,7 @@ public class ServerUtils {
     }
 
     /**
-     * Gets a single recipe based on its id
+     * Gets a single recipe based on its id.
      * @param id every recipe has it's unique id
      * @return a singe recipe with the given id
      */
@@ -70,7 +70,7 @@ public class ServerUtils {
     }
 
     /**
-     * Adds a recipe to the backend
+     * Adds a recipe to the backend.
      * @param newRecipe the recipe to be added
      * @return a recipe
      */
@@ -104,7 +104,7 @@ public class ServerUtils {
     }
 
     /**
-     * Deletes a recipe
+     * Deletes a recipe.
      * @param id the recipe that get deleted
      */
     public void deleteRecipe(long id) throws IOException, InterruptedException {
@@ -120,7 +120,7 @@ public class ServerUtils {
     }
 
     /**
-     * Clones a recipe
+     * Clones a recipe.
      * @param id the id of the recipe to be cloned
      * @return a duplicated recipe of the given recipe
      */

server/src/main/java/server/api/RecipeController.java

@@ -39,7 +39,7 @@ public class RecipeController {
     }
 
     /**
-     * Mapping for <code>GET /recipe/{id}</code>
+     * Mapping for <code>GET /recipe/{id}</code>.
      * <p>
      *     Gets a specific recipe by its unique id.
      * </p>
@@ -74,7 +74,7 @@ public class RecipeController {
     }
 
     /**
-     * Mapping for <code>POST /recipe/{id}</code>
+     * Mapping for <code>POST /recipe/{id}</code>.
      * @param id The recipe id to replace
      * @param recipe The new recipe to be replaced from the original
      * @return The changed recipe; returns 400 Bad Request if the recipe does not exist
@@ -92,7 +92,7 @@ public class RecipeController {
     }
 
     /**
-     * Mapping for <code>PUT /recipe/new</code>
+     * Mapping for <code>PUT /recipe/new</code>.
      * <p>
      *     Inserts a new recipe into the repository
      * </p>

server/src/main/java/server/api/UpdateMessagingController.java

@@ -18,7 +18,7 @@ public class UpdateMessagingController {
     }
 
     /**
-     * Mapping for STOMP: <code>SEND /updates/recipe</code>
+     * Mapping for STOMP: <code>SEND /updates/recipe</code>.
      * @param recipe The request body as a new {@link Recipe} object to update the original into
      * @return The updated {@link Recipe} object wrapped in a {@link org.springframework.http.ResponseEntity}.
      */

suppressions.xml

@@ -0,0 +1,10 @@
+<!DOCTYPE suppressions PUBLIC
+    "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+    "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+  <!-- disable MagicNumber check for all tests -->
+  <suppress checks="MagicNumber"
+            files=".*[\\/]src[\\/]test[\\/].*"/>
+</suppressions>
+