Doxygen support

include/sta/tacos/thread.hpp

@@ -12,16 +12,26 @@
 
 #include <sta/rtos/thread.hpp>
 
+/**
+ * @defgroup tacos_thread TACOS Thread
+ * @ingroup tacos
+ * @brief TACOS Thread class.
+ */
 
 namespace sta
 {
 	namespace tacos
 	{
+		/**
+		 * @brief Abstract class for thread implementations in Tacos.
+		 *
+		 * @ingroup tacos_thread
+		 */
 		class TacosThread : public RtosThread
 		{
 		public:
 			/**
-			 *
+			 * @brief Create a new thread with the given name and priority.
 			 */
 			TacosThread(const char* name, osPriority_t prio);
 
@@ -41,11 +51,13 @@ namespace sta
 
 			/**
 			 * @brief Get the currently running instance.
+			 * 
+			 * @return The currently running instance id.
 			 */
 			osThreadId_t getInstance();
 
 			/**
-			 *
+			 * @brief Get the name of this thread.
 			 */
 			const char* getName() const;
 
@@ -65,10 +77,14 @@ namespace sta
 
 			/**
 			 * @brief The body of the thread's loop. Has to be implemented by the user.
+			 *	 	This function is called repeatedly until termination is requested.
 			 */
 			virtual void func() = 0;
 
-
+			/**
+			 * @brief This function is executed when the thread is terminated. Has to be implemented by the user.
+			 * 		This function should free all ressources used by this thread.
+			 */
 			virtual void cleanup();
 
 		private: