expo: Add comments for enum bootmenu_id_t

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

Signed-off-by: Simon Glass <sjg@chromium.org>
This commit is contained in:
Simon Glass
2025-09-14 16:31:57 -06:00
parent e3e1b7aeb2
commit 8960f0a4c8

View File

@@ -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 */