Rephrased some API comments

This commit is contained in:
Th3maz1ng 2023-05-14 22:15:14 +02:00
parent 17164c722e
commit 47e31a1210

View File

@ -78,7 +78,12 @@ typedef struct WatchFace
struct tm dateTime;
} WatchFace_t;
/* Initializes the watch face context object */
/**
* @brief Initializes the watch face context object
* @note This function has to be called first before any others
*
* @param watchFace a pointer to the watch face context structure.
*/
void watch_face_init(WatchFace_t * const watchFace);
/**
@ -158,7 +163,7 @@ void watch_face_force_sync(WatchFace_t * const watchFace);
*
* @param watchFace a pointer to the watch face context structure.
* @return true if the watch face screen is being used
* @return false if the watch face screen is not being used/displayed currently
* @return false if the watch face screen is not being used/currently displayed
*/
bool watch_face_is_in_use(WatchFace_t * const watchFace);