From 243417501d7cf012ffb1a88605e7f0be43203b23 Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Fri, 21 Feb 2025 20:07:34 +0000 Subject: [PATCH] Improve menu folder documentation --- src/menu/hdmi.h | 27 ++++++++++++++++++++++----- src/menu/menu.h | 17 +++++++++++------ 2 files changed, 33 insertions(+), 11 deletions(-) diff --git a/src/menu/hdmi.h b/src/menu/hdmi.h index ce59b5a4..5ca4130d 100644 --- a/src/menu/hdmi.h +++ b/src/menu/hdmi.h @@ -1,12 +1,29 @@ +/** + * @file hdmi.h + * @brief Header file for HDMI-related functions. + * @ingroup menu + */ + #ifndef HDMI_H__ #define HDMI_H__ - #include "boot/boot.h" +/** + * @brief Clears the game ID from the HDMI interface. + * + * This function clears the current game ID from the HDMI interface. + */ +void hdmi_clear_game_id(void); -void hdmi_clear_game_id (void); -void hdmi_send_game_id (boot_params_t *boot_params); +/** + * @brief Sends the game ID to the HDMI interface. + * + * This function sends the provided game ID to the HDMI interface using the + * specified boot parameters. + * + * @param boot_params A pointer to the boot parameters containing the game ID. + */ +void hdmi_send_game_id(boot_params_t *boot_params); - -#endif +#endif // HDMI_H__ diff --git a/src/menu/menu.h b/src/menu/menu.h index a5cd14d4..01ded861 100644 --- a/src/menu/menu.h +++ b/src/menu/menu.h @@ -1,17 +1,22 @@ /** * @file menu.h * @brief Menu Subsystem - * @ingroup menu + * @ingroup menu */ #ifndef MENU_H__ #define MENU_H__ - #include "boot/boot.h" +/** + * @brief Runs the menu subsystem. + * + * This function initializes and runs the menu subsystem using the provided + * boot parameters. + * + * @param boot_params A pointer to the boot parameters. + */ +void menu_run(boot_params_t *boot_params); -void menu_run (boot_params_t *boot_params); - - -#endif +#endif // MENU_H__