Cleanup doxygen

This commit is contained in:
Henrik Stickann
2023-01-31 21:14:02 +01:00
parent a7466d6417
commit 4204c028a2
24 changed files with 89 additions and 154 deletions

View File

@@ -1,6 +1,9 @@
/**
* @file
* @brief Implementation of CanController using STM32 HAL.
*
* Configuration:
* * STA_STM32_CAN_GLOBAL: Create global CanBus object using this CAN instance
*/
#ifndef STA_CORE_STM32_CAN_HPP
#define STA_CORE_STM32_CAN_HPP
@@ -13,18 +16,6 @@
* Check @ref stm32BuildConfig for configuration options.
*/
#ifdef DOXYGEN
/**
* @def STA_STM32_CAN_GLOBAL
* @brief Create global CanBus object using this CAN instance.
*
* @ingroup stm32BuildConfig
*/
# define STA_STM32_CAN_GLOBAL
#endif // DOXYGEN
// Only enable module on STM32 platform w/ HAL CAN module enabled
#include <sta/config.hpp>
#ifdef STA_PLATFORM_STM32
@@ -35,7 +26,7 @@
#endif // STA_PLATFORM_STM32
#ifdef STA_STM32_CAN_ENABLED
#if defined(STA_STM32_CAN_ENABLED) || defined(DOXYGEN)
#include <sta/can/controller.hpp>
@@ -104,7 +95,7 @@ namespace sta
#ifdef STA_STM32_CAN_GLOBAL
#if defined(STA_STM32_CAN_GLOBAL) || DOXYGEN
/**
* @brief Global CAN instance.
*