From f01fb77db347694e3e7ecdb7f31ed99d1178ff9d Mon Sep 17 00:00:00 2001
From: Robin Jones <networkfusion@users.noreply.github.com>
Date: Wed, 23 Oct 2024 12:58:21 +0100
Subject: [PATCH] Minor comment improvements

---
 docs/99_developer_guide.md |  2 ++
 src/menu/actions.h         |  4 +++-
 src/menu/sound.h           | 17 +++++++++++++++++
 3 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/docs/99_developer_guide.md b/docs/99_developer_guide.md
index ab148140..1734b8d9 100644
--- a/docs/99_developer_guide.md
+++ b/docs/99_developer_guide.md
@@ -57,6 +57,8 @@ Generated documentation is located in the `output/docs` folder and auto-publishe
 Once merged, they can be viewed [here](https://polprzewodnikowy.github.io/N64FlashcartMenu/)
 
 ### Test generated docs in the dev-container
+Testing the documentation locally allows you to preview changes and ensure everything renders correctly before submitting your changes.
+
 Install Prerequisites:
 ```bash
 apt-get install ruby-full build-essential zlib1g-dev
diff --git a/src/menu/actions.h b/src/menu/actions.h
index e02e35af..f10a83ce 100644
--- a/src/menu/actions.h
+++ b/src/menu/actions.h
@@ -10,7 +10,9 @@
 
 #include "menu_state.h"
 
-
+/**
+ * @brief Initialize the actions module
+ */
 void actions_init (void);
 void actions_update (menu_t *menu);
 
diff --git a/src/menu/sound.h b/src/menu/sound.h
index 8752a9b9..e086a362 100644
--- a/src/menu/sound.h
+++ b/src/menu/sound.h
@@ -12,6 +12,9 @@
 #define SOUND_MP3_PLAYER_CHANNEL    (0)
 #define SOUND_SFX_CHANNEL           (2)
 
+/**
+ * @brief Enumeration of available sound effects for menu interactions.
+ */
 typedef enum {
     SFX_CURSOR,
     SFX_ERROR,
@@ -23,8 +26,22 @@ typedef enum {
 
 void sound_init_default (void);
 void sound_init_mp3_playback (void);
+
+/**
+ * @brief Initialize sound effects system.
+ */
 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);
+
+/**
+ * @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);