Th3maz1ng/W800_Smart_Watch
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added more documentation comments

Browse Source
This commit is contained in:
Anatole SCHRAMM 2023-07-06 15:28:18 +02:00
parent 8af4e2467e
commit ece0d08ae7
2 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/W800_SDK_v1.00.10/app/gfx/music_player_screen.h
View File

@ -58,6 +58,12 @@ typedef struct MusicPlayerScreen
bool ble_connection_state; bool ble_connection_state;
} MusicPlayerScreen_t; } MusicPlayerScreen_t;
/**
* @brief Initializes the music player screen's context object
* @note This function has to be called first before any others
*
* @param musicPlayerScreen a pointer to the music player screen's context structure to initialize.
*/
void music_player_screen_init(MusicPlayerScreen_t * const musicPlayerScreen); void music_player_screen_init(MusicPlayerScreen_t * const musicPlayerScreen);
void music_player_screen_register_music_playback_control_cb(MusicPlayerScreen_t * const musicPlayerScreen, MusicPlaybackCtrlCb_t musicPlaybackCtrlCb); void music_player_screen_register_music_playback_control_cb(MusicPlayerScreen_t * const musicPlayerScreen, MusicPlaybackCtrlCb_t musicPlaybackCtrlCb);
@ -76,8 +82,18 @@ void music_player_screen_set_music_playing_state(MusicPlayerScreen_t * const mus
bool music_player_screen_is_in_use(MusicPlayerScreen_t * const musicPlayerScreen); bool music_player_screen_is_in_use(MusicPlayerScreen_t * const musicPlayerScreen);
/**
* @brief Graphically builds the music player screen.
*
* @param musicPlayerScreen a pointer to the music player screen's context structure to initialize.
*/
void music_player_screen_create(MusicPlayerScreen_t * const musicPlayerScreen); void music_player_screen_create(MusicPlayerScreen_t * const musicPlayerScreen);
/**
* @brief Frees all resources used by the MusicPlayerScreen object.
*
* @param musicPlayerScreen a pointer to the music player screen's context structure to initialize.
*/
void music_player_screen_destroy(MusicPlayerScreen_t * const musicPlayerScreen); void music_player_screen_destroy(MusicPlayerScreen_t * const musicPlayerScreen);
#endif // MUSIC_PLAYER_SCREEN_H #endif // MUSIC_PLAYER_SCREEN_H

4
src/W800_SDK_v1.00.10/app/gfx/watch_face.h
View File

@ -113,7 +113,7 @@ void watch_face_register_battery_indicator_cb(WatchFace_t * const watchFace, Bat
void watch_face_register_step_counter_indicator_cb(WatchFace_t * const watchFace, StepCounterIndicatorCb_t stepCounterIndicatorCb); void watch_face_register_step_counter_indicator_cb(WatchFace_t * const watchFace, StepCounterIndicatorCb_t stepCounterIndicatorCb);
/** /**
* @brief Graphically builds the watch face * @brief Graphically builds the watch face.
* *
* @param watchFace a pointer to the watch face context structure. * @param watchFace a pointer to the watch face context structure.
*/ */
@ -168,7 +168,7 @@ void watch_face_force_sync(WatchFace_t * const watchFace);
bool watch_face_is_in_use(WatchFace_t * const watchFace); bool watch_face_is_in_use(WatchFace_t * const watchFace);
/** /**
* @brief Frees all resources used by the WatchFace object * @brief Frees all resources used by the WatchFace object.
* *
* @param watchFace a pointer to the watch face context structure. * @param watchFace a pointer to the watch face context structure.
*/ */