Remove template, add description to header

MaJerle · Jul 14, 2021 · 7a28a7b · 7a28a7b
1 parent 525dfc9
commit 7a28a7b
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 170 deletions.
diff --git a/lwow/src/include/lwow/lwow.h b/lwow/src/include/lwow/lwow.h
@@ -131,9 +131,36 @@ typedef struct {
  * \{
  */
 
+/**
+ * \brief           Create a new mutex and assign value to handle
+ * \param[out]      mutex: Output variable to save mutex handle
+ * \param[in]       arg: User argument passed on \ref lwow_init function
+ * \return          `1` on success, `0` otherwise
+ */
 uint8_t lwow_sys_mutex_create(LWOW_CFG_OS_MUTEX_HANDLE* mutex, void* arg);
+
+/**
+ * \brief           Delete existing mutex and invalidate mutex variable
+ * \param[in]       mutex: Mutex handle to remove and invalidate
+ * \param[in]       arg: User argument passed on \ref lwow_init function
+ * \return          `1` on success, `0` otherwise
+ */
 uint8_t lwow_sys_mutex_delete(LWOW_CFG_OS_MUTEX_HANDLE* mutex, void* arg);
+
+/**
+ * \brief           Wait for a mutex until ready (unlimited time)
+ * \param[in]       mutex: Mutex handle to wait for
+ * \param[in]       arg: User argument passed on \ref lwow_init function
+ * \return          `1` on success, `0` otherwise
+ */
 uint8_t lwow_sys_mutex_wait(LWOW_CFG_OS_MUTEX_HANDLE* mutex, void* arg);
+
+/**
+ * \brief           Release already locked mutex
+ * \param[in]       mutex: Mutex handle to release
+ * \param[in]       arg: User argument passed on \ref lwow_init function
+ * \return          `1` on success, `0` otherwise
+ */
 uint8_t lwow_sys_mutex_release(LWOW_CFG_OS_MUTEX_HANDLE* mutex, void* arg);
 
 /**

diff --git a/lwow/src/system/lwow_ll_template.c b/lwow/src/system/lwow_ll_template.c
diff --git a/lwow/src/system/lwow_sys_template.c b/lwow/src/system/lwow_sys_template.c