Doxygen support

include/sta/tacos/manager.hpp

@@ -13,20 +13,34 @@
 
 #ifndef STA_TACOS_MANAGER_PRIORITY
 #	error "Manger task priority not specified in config.hpp"
-#else
+#else 
 
 #include <set>
 #include <list>
 #include <memory>
 #include <sta/tacos/thread.hpp>
 
+/**
+ * @defgroup tacos_manager Manager Task
+ * @ingroup tacos
+ * @brief Manager task for TACOS.
+ */
+
 namespace sta
 {
 	namespace tacos
 	{
+		/**
+		 * @brief Manager class for Tacos.
+		 *
+		 * @ingroup tacos_manager
+		 */
 		class Manager : public TacosThread
 		{
 		public:
+			/**
+			 * @brief Get the singleton instance of the manager.
+			 */
 			static Manager* instance()
 			{
 				static CGuard g;
@@ -41,7 +55,7 @@ namespace sta
 			}
 
 			/**
-			 *
+			 * @brief Register a thread to be managed by the manager.
 			 */
 			void registerThread(std::shared_ptr<TacosThread> thread, std::list<uint16_t> states);
 
@@ -71,12 +85,26 @@ namespace sta
 
 			//~Manager();
 
+			/**
+			 * @brief Forces only threads of current state to run.
+			 */
 			void updateThreads();
 
+			/**
+			 * @brief Starts all threads which should be running in the given state. Does nothing if the state is already running.
+			 */
 			void startThreads(uint16_t state);
 
+			/**
+			 * @brief Stops all threads which should not be running in the given state.
+			 */
 			void stopThreads(uint16_t state);
 
+			/**
+			 * @brief Pointers to all threads which are managed by the manager.
+			 * 
+			 * @ingroup tacos_manager
+			 */
 			std::set<std::shared_ptr<TacosThread>> threads_[STA_TACOS_NUM_STATES];
 		};
 	}  // namespace tacos