Improved grouping and allow doxygen without other defines

This commit is contained in:
@CarlWachter
2024-01-06 13:02:54 +01:00
parent 759495f2ce
commit 4357b27ae4
5 changed files with 66 additions and 18 deletions

View File

@@ -6,8 +6,10 @@
*/
/**
* @defgroup tacos
* @brief TACOS library.
* @defgroup tacos TACOS Library
* @brief TACOS library
*
* @details This library contains the internal functions of TACOS. It is not intended to be used by the user, but is documented rather for anyone wanting to contribute to the project.
*/
@@ -31,6 +33,12 @@
// The UART mutex defined in freertos.c
extern osMutexId_t uartMutexHandle;
/**
* @defgroup tacos_startup Startup
* @ingroup tacos
* @brief Functions that are called during startup.
*/
namespace sta
{
@@ -60,6 +68,8 @@ namespace sta
/**
* @brief Function that is called before the statemachine task is started. Override it to
* adjust the statemachine to your specifications.
*
* @ingroup tacos_startup
*/
STA_WEAK
void onStatemachineInit()
@@ -75,6 +85,8 @@ namespace sta
/**
* @brief Function that is called before the manager task is started. Override it to adjust
* the manager to your specifications.
*
* @ingroup tacos_startup
*/
STA_WEAK
void onManagerInit()