diff --git a/checkstyle.xml b/checkstyle.xml index 2219dec..4932a91 100644 --- a/checkstyle.xml +++ b/checkstyle.xml @@ -4,8 +4,10 @@ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd"> + + + - @@ -67,6 +69,7 @@ + @@ -80,13 +83,13 @@ where applicable. --> + + - - + - - + diff --git a/client/src/main/java/client/scenes/FoodpalApplicationCtrl.java b/client/src/main/java/client/scenes/FoodpalApplicationCtrl.java index 0b3aeba..bcb6f44 100644 --- a/client/src/main/java/client/scenes/FoodpalApplicationCtrl.java +++ b/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: *
    *
  1. User creates an untitled recipe
  2. @@ -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(); diff --git a/client/src/main/java/client/utils/ServerUtils.java b/client/src/main/java/client/utils/ServerUtils.java index 7bf5de9..1e7ee98 100644 --- a/client/src/main/java/client/utils/ServerUtils.java +++ b/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 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 */ @@ -197,4 +197,4 @@ public class ServerUtils { updateRecipe(recipe); } -} \ No newline at end of file +} diff --git a/server/src/main/java/server/api/RecipeController.java b/server/src/main/java/server/api/RecipeController.java index 403de13..b921bf0 100644 --- a/server/src/main/java/server/api/RecipeController.java +++ b/server/src/main/java/server/api/RecipeController.java @@ -39,7 +39,7 @@ public class RecipeController { } /** - * Mapping for GET /recipe/{id} + * Mapping for GET /recipe/{id}. *

    * Gets a specific recipe by its unique id. *

    @@ -74,7 +74,7 @@ public class RecipeController { } /** - * Mapping for POST /recipe/{id} + * Mapping for POST /recipe/{id}. * @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 PUT /recipe/new + * Mapping for PUT /recipe/new. *

    * Inserts a new recipe into the repository *

    diff --git a/server/src/main/java/server/api/UpdateMessagingController.java b/server/src/main/java/server/api/UpdateMessagingController.java index e7e75bd..3af8a85 100644 --- a/server/src/main/java/server/api/UpdateMessagingController.java +++ b/server/src/main/java/server/api/UpdateMessagingController.java @@ -18,7 +18,7 @@ public class UpdateMessagingController { } /** - * Mapping for STOMP: SEND /updates/recipe + * Mapping for STOMP: SEND /updates/recipe. * @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}. */ diff --git a/suppressions.xml b/suppressions.xml new file mode 100644 index 0000000..5935fec --- /dev/null +++ b/suppressions.xml @@ -0,0 +1,10 @@ + + + + + + +