Rephrased some API comments
This commit is contained in:
parent
17164c722e
commit
47e31a1210
@ -78,7 +78,12 @@ typedef struct WatchFace
|
|||||||
struct tm dateTime;
|
struct tm dateTime;
|
||||||
} WatchFace_t;
|
} 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);
|
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.
|
* @param watchFace a pointer to the watch face context structure.
|
||||||
* @return true if the watch face screen is being used
|
* @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);
|
bool watch_face_is_in_use(WatchFace_t * const watchFace);
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user