Doxygen support

include/sta/tacos/statemachine.hpp

@@ -10,7 +10,6 @@
 
 #include <sta/config.hpp>
 
-
 #ifndef STA_TACOS_NUM_STATES
 #	error "Number of states wasn't defined in config.hpp"
 #else
@@ -20,6 +19,7 @@
 #	define STA_TACOS_INITIAL_STATE 0
 #endif
 
+
 #define STA_TACOS_STATEMACHINE_QUEUE_LENGTH		4
 
 // State transition happened because of
@@ -41,10 +41,21 @@
 #include <tuple>
 
 
+/**
+ * @defgroup tacos_statemachine Statemachine Task
+ * @ingroup tacos
+ * @brief Statemachine task for TACOS.
+ */
+
 namespace sta
 {
 	namespace tacos
 	{
+		/**
+		 * @brief Event flags for state transitions.
+		 *
+		 * @ingroup tacos_statemachine
+		 */
 		enum EventFlags
 		{
 			NORMAL 				= 0x1U,
@@ -54,6 +65,11 @@ namespace sta
 			ALL					= NORMAL | FORCED | TIMEOUT | STARTUP
 		};
 
+		/**
+		 * @brief State transition structure.
+		 *
+		 * @ingroup tacos_statemachine
+		 */
 		struct StateTransition
 		{
 			uint16_t from;
@@ -62,7 +78,11 @@ namespace sta
 			uint32_t lockout;
 		};
 
-
+		/**
+		 * @brief Statemachine implementation for Tacos.
+		 *
+		 * @ingroup tacos_statemachine
+		 */
 		class Statemachine : public TacosThread
 		{
 		public:
@@ -139,6 +159,8 @@ namespace sta
 		private:
 			/**
 			 * @brief Starts the lockoutTimer for the desired duration.
+			 * 
+			 * @param millis The duration of the timer in milliseconds.
 			 */
 			void setLockoutTimer(uint32_t millis);