mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2024-11-25 20:16:54 +01:00
Minor comment improvements
This commit is contained in:
parent
1b112bfa11
commit
f01fb77db3
@ -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
|
||||
|
@ -10,7 +10,9 @@
|
||||
|
||||
#include "menu_state.h"
|
||||
|
||||
|
||||
/**
|
||||
* @brief Initialize the actions module
|
||||
*/
|
||||
void actions_init (void);
|
||||
void actions_update (menu_t *menu);
|
||||
|
||||
|
@ -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);
|
||||
|
Loading…
Reference in New Issue
Block a user