The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2024-11-29 14:04:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Minor comment improvements

Browse Source
This commit is contained in:
Robin Jones 2024-10-23 12:58:21 +01:00
parent 1b112bfa11
commit f01fb77db3
3 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/99_developer_guide.md
View File

@ -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/) Once merged, they can be viewed [here](https://polprzewodnikowy.github.io/N64FlashcartMenu/)
### Test generated docs in the dev-container ### 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: Install Prerequisites:
```bash ```bash
apt-get install ruby-full build-essential zlib1g-dev apt-get install ruby-full build-essential zlib1g-dev

4
src/menu/actions.h
View File

@ -10,7 +10,9 @@
#include "menu_state.h" #include "menu_state.h"
/**
* @brief Initialize the actions module
*/
void actions_init (void); void actions_init (void);
void actions_update (menu_t *menu); void actions_update (menu_t *menu);

17
src/menu/sound.h
View File

@ -12,6 +12,9 @@
#define SOUND_MP3_PLAYER_CHANNEL (0) #define SOUND_MP3_PLAYER_CHANNEL (0)
#define SOUND_SFX_CHANNEL (2) #define SOUND_SFX_CHANNEL (2)
/**
* @brief Enumeration of available sound effects for menu interactions.
*/
typedef enum { typedef enum {
SFX_CURSOR, SFX_CURSOR,
SFX_ERROR, SFX_ERROR,
@ -23,8 +26,22 @@ typedef enum {
void sound_init_default (void); void sound_init_default (void);
void sound_init_mp3_playback (void); void sound_init_mp3_playback (void);
/**
* @brief Initialize sound effects system.
*/
void sound_init_sfx (void); 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);
/**
* @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_play_effect(sound_effect_t sfx);
void sound_deinit (void); void sound_deinit (void);
void sound_poll (void); void sound_poll (void);