From 5942250f11e6438f1d89665d4881172d883c8fd5 Mon Sep 17 00:00:00 2001
From: Steven Liu <z.liu-74@student.tudelft.nl>
Date: Sat, 17 Jan 2026 13:37:24 +0100
Subject: [PATCH] docs: add notes to makeMenuItems

---
 .../scenes/recipe/IngredientListCell.java     | 24 +++++++++++++++----
 1 file changed, 20 insertions(+), 4 deletions(-)

diff --git a/client/src/main/java/client/scenes/recipe/IngredientListCell.java b/client/src/main/java/client/scenes/recipe/IngredientListCell.java
index f29dd8d..a96c5fc 100644
--- a/client/src/main/java/client/scenes/recipe/IngredientListCell.java
+++ b/client/src/main/java/client/scenes/recipe/IngredientListCell.java
@@ -82,6 +82,18 @@ public class IngredientListCell extends OrderedEditableListCell<RecipeIngredient
         this.setText(null);
         this.setGraphic(container);
     }
+
+    /**
+     * Creates a menu of ingredients from the provided iterable list of items.
+     * Modifies the provided <code>menu</code> reference.
+     * @param menu          The MenuButton to add items to.
+     * @param items         The items to add to the dropdown menu.
+     * @param labelMapper   A function that outputs a string from the object to display on the label.
+     * @param onSelect      Callback that triggers upon selection.
+     * @param container     Parent container of the menu.
+     *                      Required since the UI logic needs to append a field to the end of the HBox upon selection
+     * @param <T>           The type this menu concerns itself with.
+     */
     private <T> void makeMenuItems(
             MenuButton menu,
             Iterable<T> items,
@@ -90,15 +102,21 @@ public class IngredientListCell extends OrderedEditableListCell<RecipeIngredient
             HBox container) {
         MenuItem newIngredientItem = new MenuItem();
         newIngredientItem.setText("Something new...");
+
+        // on new ingredient click
         newIngredientItem.setOnAction(_ -> {
-            menu.setText("New Ingredient");
-            selectedIngredient.setValue(null);
+            menu.setText("New Ingredient"); // otherwise the text label on menu refuses to update
+            selectedIngredient.setValue(null); // indicate null to signal a new ingredient creation
             logger.info("Making new ingredient");
             // TODO printError() integration
             TextField newIngredientNameInput = makeNewIngredientNameField(selectedIngredient::set);
             container.getChildren().add(newIngredientNameInput);
         });
+
+        // Puts the add ingredient button and a separator on top of the dropdown menu.
         menu.getItems().addAll(newIngredientItem, new SeparatorMenuItem());
+
+        // Iterates over the list of items and applies the label and onSelect handlers.
         for (T item : items) {
             MenuItem mi = new MenuItem();
             mi.setText(labelMapper.apply(item));
@@ -127,8 +145,6 @@ public class IngredientListCell extends OrderedEditableListCell<RecipeIngredient
             Unit unit = unitChoice.getValue();
             Ingredient i = selectedIngredient.getValue();
             if (i == null) {
-
-
                 return; // The user is forced to kindly try again until something valid comes up.
             }
             if (unit == null || !unit.isFormal()) {