steven/csep-2025
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: add periods to all sentences.

Browse source
This commit is contained in:
Zhongheng Liu 2025-12-07 21:17:49 +01:00
commit ea840f032e
Signed by: steven
GPG key ID: F69B980899C1C09D
4 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

8
client/src/main/java/client/scenes/FoodpalApplicationCtrl.java
View file

@ -212,7 +212,7 @@ public class FoodpalApplicationCtrl implements LocaleAware {
alert.showAndWait(); 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: * The UX flow is now:
* <ol> * <ol>
* <li>User creates an untitled recipe</li> * <li>User creates an untitled recipe</li>
@ -263,8 +263,8 @@ public class FoodpalApplicationCtrl implements LocaleAware {
} }
/** /**
* Revised edit recipe control flow, deprecates the use of a separate AddNameCtrl * 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 * This is automagically called when a new recipe is created, making for a more seamless UX.
*/ */
@FXML @FXML
private void editRecipeTitle() { private void editRecipeTitle() {
@ -310,7 +310,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 { public void cloneRecipe() throws IOException, InterruptedException {
Recipe selected = recipeList.getSelectionModel().getSelectedItem(); Recipe selected = recipeList.getSelectionModel().getSelectedItem();

10
client/src/main/java/client/utils/ServerUtils.java
View file

@ -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 * @return a JSON string with all the recipes
*/ */
public List<Recipe> getRecipes() throws IOException, InterruptedException { 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 * @param id every recipe has it's unique id
* @return a singe recipe with the given 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 * @param newRecipe the recipe to be added
* @return a recipe * @return a recipe
*/ */
@ -104,7 +104,7 @@ public class ServerUtils {
} }
/** /**
* Deletes a recipe * Deletes a recipe.
* @param id the recipe that get deleted * @param id the recipe that get deleted
*/ */
public void deleteRecipe(long id) throws IOException, InterruptedException { 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 * @param id the id of the recipe to be cloned
* @return a duplicated recipe of the given recipe * @return a duplicated recipe of the given recipe
*/ */

6
server/src/main/java/server/api/RecipeController.java
View file

@ -39,7 +39,7 @@ public class RecipeController {
} }
/** /**
* Mapping for <code>GET /recipe/{id}</code> * Mapping for <code>GET /recipe/{id}</code>.
* <p> * <p>
* Gets a specific recipe by its unique id. * Gets a specific recipe by its unique id.
* </p> * </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 id The recipe id to replace
* @param recipe The new recipe to be replaced from the original * @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 * @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> * <p>
* Inserts a new recipe into the repository * Inserts a new recipe into the repository
* </p> * </p>

2
server/src/main/java/server/api/UpdateMessagingController.java
View file

@ -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 * @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}. * @return The updated {@link Recipe} object wrapped in a {@link org.springframework.http.ResponseEntity}.
*/ */