Rework. Improve doxygen documentation

This commit is contained in:
Henrik Stickann
2022-05-08 03:15:08 +02:00
parent 0fe1be1863
commit b09de25c62
14 changed files with 340 additions and 117 deletions

View File

@@ -1,6 +1,3 @@
/**
* @brief System startup task.
*/
#include <sta/rtos2/startup.hpp>
#ifdef STA_RTOS2_STARTUP_ENABLE
@@ -12,11 +9,6 @@
#include <cmsis_os2.h>
#ifndef STA_RTOS2_STARTUP_ENTRY_FUNCTION
# define STA_RTOS2_STARTUP_ENTRY_FUNCTION startupTask
#endif // !STA_RTOS2_STARTUP_ENTRY_FUNCTION
namespace sta
{
// Provide weak implementation to allow overriding

View File

@@ -5,10 +5,6 @@
#include <cmsis_os2.h>
#ifndef STA_RTOS2_SYSTEM_EVENT_HANDLE
# define STA_RTOS2_SYSTEM_EVENT_HANDLE systemEventHandle
#endif // !STA_RTOS2_SYSTEM_EVENT_HANDLE
// Access handle from freertos.c
extern osEventFlagsId_t STA_RTOS2_SYSTEM_EVENT_HANDLE;

View File

@@ -5,19 +5,6 @@
#include <cmsis_os2.h>
#ifndef STA_RTOS2_WATCHDOG_TIMER_PERIOD
# define STA_RTOS2_WATCHDOG_TIMER_PERIOD 1000
#endif // !STA_RTOS2_WATCHDOG_TIMER_PERIOD
#ifndef STA_RTOS2_WATCHDOG_TIMER_HANDLE
# define STA_RTOS2_WATCHDOG_TIMER_HANDLE heartbeatHandle
#endif // !STA_RTOS2_WATCHDOG_TIMER_HANDLE
#ifndef STA_RTOS2_WATCHDOG_TIMER_CALLBACK
# define STA_RTOS2_WATCHDOG_TIMER_CALLBACK heartbeatCallback
#endif // !STA_RTOS2_WATCHDOG_TIMER_CALLBACK
// Access handles from freertos.c
extern osTimerId_t STA_RTOS2_WATCHDOG_TIMER_HANDLE;

View File

@@ -10,15 +10,6 @@
#include <cmsis_os2.h>
#ifndef STA_RTOS2_WATCHDOG_HANDLE
# define STA_RTOS2_WATCHDOG_HANDLE watchdogHandle
#endif // !STA_RTOS2_WATCHDOG_HANDLE
#ifndef STA_RTOS2_WATCHDOG_ENTRY_FUNCTION
# define STA_RTOS2_WATCHDOG_ENTRY_FUNCTION watchdogTask
#endif // !STA_RTOS2_WATCHDOG_ENTRY_FUNCTION
// Access handle from freertos.c
extern osThreadId_t STA_RTOS2_WATCHDOG_HANDLE;