Added API group

include/sta/tacos.hpp

@@ -15,6 +15,12 @@
 #include <initializer_list>
 #include <type_traits>
 
+/**
+ * @defgroup tacos_api TACOS API
+ * @brief Functions and classes that are used to interact with TACOS.
+ * 
+ * @details This module contains all functions and classes that are used to interact with TACOS. It is the only module that should be used in user code.
+ */
 
 namespace sta
 {
@@ -24,6 +30,8 @@ namespace sta
 		 * @brief Get the current state of the TACOS statemachine.
 		 * 
 		 * @return uint16_t Returns the state.
+		 * 
+		 * @ingroup tacos_api
 		 */
 		uint16_t getState();
 
@@ -33,6 +41,8 @@ namespace sta
 		 * @param from The start we want to transition from.
 		 * @param to The state we want to transition to.
 		 * @param lockout An optional timer blocking state transition for a given time.
+		 * 
+		 * @ingroup tacos_api
 		 */
 		void setState(uint32_t from, uint32_t to, uint32_t lockout = 0);
 
@@ -43,6 +53,8 @@ namespace sta
 		 * @param to The state we want to transition to.
 		 * @param millis The time to wait until the transition is requested.
 		 * @param lockout An optional timer blocking state transition for a given time. Will be active after this transition was executed.
+		 * 
+		 * @ingroup tacos_api
 		 */
 		void setStateTimed(uint32_t from, uint32_t to, uint32_t millis, uint32_t lockout = 0);
 
@@ -52,6 +64,8 @@ namespace sta
 		 * @tparam T The class of the thread to be created. A subclass of TacosThread.
 		 * @param states A list of states in which the thread should run. 
 		 * @param args The constructor arguments for the provided class.
+		 * 
+		 * @ingroup tacos_api
 		 */
 		template<typename T, typename ... Args>
 		void addThread(std::list<uint16_t> states, Args ... args)