From 9bbee1e24aa6a593052f051bc1bcc534f4f7e032 Mon Sep 17 00:00:00 2001 From: Robin Jones Date: Fri, 21 Feb 2025 22:52:08 +0000 Subject: [PATCH] fix enable sfx improve documentation. --- src/menu/sound.h | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/src/menu/sound.h b/src/menu/sound.h index 97d83d23..f0fee92e 100644 --- a/src/menu/sound.h +++ b/src/menu/sound.h @@ -52,16 +52,31 @@ void sound_init_sfx(void); /** * @brief Enable or disable sound effects. + * * @param enable True to enable sound effects, false to disable. */ -void sound_use_sfx(bool); +void sound_use_sfx(bool enable); /** * @brief Play a specified sound effect. + * * @param sfx The sound effect to play, as defined in sound_effect_t. */ void sound_play_effect(sound_effect_t sfx); -void sound_deinit (void); -void sound_poll (void); + +/** + * @brief Deinitialize the sound system. + * + * This function deinitializes the sound system, releasing any resources + * that were allocated. + */ +void sound_deinit(void); + +/** + * @brief Poll the sound system. + * + * This function polls the sound system, updating its state as necessary. + */ +void sound_poll(void); #endif /* SOUND_H__ */