From 47e31a12107f3e5eea5302fdbcc179cb54f86695 Mon Sep 17 00:00:00 2001 From: Th3maz1ng Date: Sun, 14 May 2023 22:15:14 +0200 Subject: [PATCH] Rephrased some API comments --- src/W800_SDK_v1.00.10/app/gfx/watch_face.h | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/W800_SDK_v1.00.10/app/gfx/watch_face.h b/src/W800_SDK_v1.00.10/app/gfx/watch_face.h index 18ec587..9aed859 100644 --- a/src/W800_SDK_v1.00.10/app/gfx/watch_face.h +++ b/src/W800_SDK_v1.00.10/app/gfx/watch_face.h @@ -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);