diff mbox series

[Concept,07/23] expo: Add comments for enum bootmenu_id_t

Message ID 20250915122905.1217249-8-sjg@u-boot.org
State New
Headers
Series expo: Support interactions with a mouse or touchpad |

Commit Message

Simon Glass Sept. 15, 2025, 12:28 p.m. UTC 
  From: Simon Glass <sjg@chromium.org>

Document the ranges in this enum, so it is clear what they a used for.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

 boot/bootflow_internal.h | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/boot/bootflow_internal.h b/boot/bootflow_internal.h
index 4cdb6966a7b..0b17a23bfd7 100644
--- a/boot/bootflow_internal.h
+++ b/boot/bootflow_internal.h
@@ -9,8 +9,18 @@ 
 #ifndef __BOOTFLOW_INTERNAL_H
 #define __BOOTFLOW_INTERNAL_H
 
-/* expo IDs for elements of the bootflow menu */
-enum {
+/**
+ * enum boomenu_id_t - expo IDs for elements of the bootflow menu
+ *
+ * The ranges below are as follows:
+ *
+ * @ITEM: Menu items
+ * @ITEM_LABEL: Short Media or other label to indicate what it is, e.g. "mmc0"
+ * @ITEM_DESC: Longer description or pretty name, e.g. "Ubuntu 2024.04 LTS"
+ * @ITEM_KEY: Keypress to select this item, e.g. "1"
+ * @ITEM_PREVIEW: Preview image for the OS
+ */
+enum boomenu_id_t {
 	START,
 
 	/* strings */