Full Doxygen documentation

include/sta/rtos/signal.hpp

@@ -9,13 +9,19 @@
 
 #include <cmsis_os2.h>
 
+/**
+ * @defgroup STA_RTOS_SIGNAL Signal
+ * @ingroup STA_RTOS_API
+ * @brief RTOS Signal.
+ */
 
 namespace sta
 {
 	/**
 	 * @brief Implementation of Signal interface using CMSIS RTOS2.
 	 *
-	 * @ingroup STA_RTOS_API
+	 * @ingroup STA_RTOS_SIGNAL
+	 * 
 	 */
 	class RtosSignal : public Signal
 	{
@@ -25,9 +31,28 @@ namespace sta
 		 */
 		RtosSignal(osSemaphoreId_t semaphore);
 
+		/**
+		 * @brief Notify the signal.
+		 */
 		void notify() override;
+
+		/**
+		 * @brief Check if the signal is set.
+		 *
+		 * @return true if the signal is set.
+		 */
 		bool peek() override;
+
+		/**
+		 * @brief Check if the signal is set and clear it.
+		 *
+		 * @return true if the signal was set.
+		 */
 		bool test() override;
+
+		/**
+		 * @brief Wait for the signal to be set.
+		 */
 		void wait() override;
 
 	private: