Mercurial > co2meter / file diff

--- a/main/task_user.h	Tue Nov 05 11:31:59 2019 +0100
+++ b/main/task_user.h	Thu Nov 07 11:47:15 2019 +0100
@@ -1,6 +1,6 @@
 /**
  * @file task_user.h
- * @brief The FreeRTOS task to maintain MQTT connections.
+ * @brief The FreeRTOS task to run the user interface.
  */
 
 #ifndef	_TASK_USER_H
@@ -20,9 +20,28 @@
 
 
 
+/**
+ * @brief Called after a power on or hard reset.
+ */
 void user_cold(void);
+
+
+/**
+ * @brief Called after wakeup by the user.
+ */
 void user_wakeup(void);
+
+
+/**
+ * @brief Refresh screens that are in focus.
+ */
 void user_refresh(void);
+
+
+/**
+ * @brief Test is user interface is busy and active
+ * @return Returns true if the user interface is active, false otherwise.
+ */
 bool user_busy(void);