Full Doxygen documentation

This commit is contained in:
@CarlWachter
2024-01-06 16:30:30 +01:00
parent b30d47413b
commit b4b214a756
10 changed files with 137 additions and 111 deletions

View File

@@ -3,6 +3,11 @@
#include <type_traits>
/**
* @defgroup STA_RTOS_HANDLE Handle
* @ingroup STA_RTOS_API
* @brief Helper for managing access to RTOS handles.
*/
namespace sta
{
@@ -11,7 +16,7 @@ namespace sta
*
* @tparam T CMSIS RTOS2 handle type
*
* @ingroup STA_RTOS_API
* @ingroup STA_RTOS_HANDLE
*/
template <typename T>
class RtosHandle
@@ -27,6 +32,7 @@ namespace sta
*/
struct Deferred
{
/// @brief Handle variable address type
handle_type * pointer;
/**