Cleanup doxygen

include/sta/stm32/can.hpp

@@ -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.
 	 *

include/sta/stm32/clocks.hpp

@@ -26,7 +26,7 @@
 
 // Only enable module on STM32 platform
 #include <sta/config.hpp>
-#ifdef STA_PLATFORM_STM32
+#if defined(STA_PLATFORM_STM32) || defined(DOXYGEN)
 
 #include <sta/stm32/hal.hpp>
 

include/sta/stm32/delay.hpp

@@ -1,6 +1,12 @@
 /**
  * @file
  * @brief Delay functions.
+ *
+ * Configuration:
+ *   * STA_STM32_DELAY_US_TIM: 1 MHz TIM instance used by sta::delayUs
+ *
+ * NOTE: TIM time base must be started before use of sta::delayUs by calling sta::initHAL.
+ *       When using startup system task this is handled automatically.
  */
 #ifndef STA_CORE_STM32_DELAY_HPP
 #define STA_CORE_STM32_DELAY_HPP
@@ -11,23 +17,9 @@
  * @brief STM32 Delay module.
  */
 
-#ifdef DOXYGEN
-/**
- * @def STA_STM32_DELAY_US_TIM
- * @brief 1 MHz TIM instance used by sta::delayUs.
- *
- * NOTE: TIM time base must be started before use of sta::delayUs by calling sta::initHAL.
- *       When using startup system task this is handled automatically.
- *
- * @ingroup stm32BuildConfig
- */
-#  define STA_STM32_DELAY_US_TIM
-#endif // DOXYGEN
-
-
 // Only enable module on STM32 platform
 #include <sta/config.hpp>
-#ifdef STA_PLATFORM_STM32
+#if defined(STA_PLATFORM_STM32) || defined(DOXYGEN)
 
 #include <cstdint>
 
@@ -43,7 +35,7 @@ namespace sta
 	 */
 	void delayMs(uint32_t ms);
 
-#ifdef STA_STM32_DELAY_US_TIM
+#if defined(STA_STM32_DELAY_US_TIM) || defined(DOXYGEN)
 	/**
 	 * @brief Microsecond delay.
 	 *

include/sta/stm32/gpio_pin.hpp

@@ -11,17 +11,6 @@
  * @brief STM32 GPIO module.
  */
 
-#ifdef DOXYGEN
-/**
- * @def STA_STM32_GPIO_ENABLE
- * @brief Enable module.
- *
- * @ingroup stm32BuildConfig
- */
-#  define STA_STM32_GPIO_ENABLE
-#endif // DOXYGEN
-
-
 // Only enable module on STM32 platform w/ HAL GPIO module enabled
 #include <sta/config.hpp>
 #ifdef STA_PLATFORM_STM32
@@ -32,7 +21,7 @@
 #endif // STA_PLATFORM_STM32
 
 
-#ifdef STA_STM32_GPIO_ENABLED
+#if defined(STA_STM32_GPIO_ENABLED) || defined(DOXYGEN)
 
 #include <sta/gpio_pin.hpp>
 

include/sta/stm32/hal.hpp

@@ -1,3 +1,7 @@
+/**
+ * @file
+ * @brief Generic header for including the STM32 HAL headers.
+ */
 #ifndef STA_CORE_STM32_HAL_HPP
 #define STA_CORE_STM32_HAL_HPP
 

include/sta/stm32/mcu/STM32F411xE.hpp

@@ -1,4 +1,5 @@
 /**
+ * @file
  * @brief Configuration for STM32F411xE family.
  */
 #ifndef STA_CORE_STM32_MCU_STM32F411xE_HPP

include/sta/stm32/mcu/STM32F413xx.hpp

@@ -1,4 +1,5 @@
 /**
+ * @file
  * @brief Configuration for STM32F413xx family.
  */
 #ifndef STA_CORE_STM32_MCU_STM32F413xx_HPP

include/sta/stm32/mcu/common.hpp

@@ -1,4 +1,5 @@
 /**
+ * @file
  * @brief Common configuration for STM32 MCUs
  */
 #ifndef STA_CORE_STM32_MCU_COMMON_HPP

include/sta/stm32/spi.hpp

@@ -24,8 +24,7 @@
 #  endif // HAL_SPI_MODULE_ENABLED
 #endif // STA_PLATFORM_STM32
 
-
-#ifdef STA_STM32_SPI_ENABLED
+#if defined(STA_STM32_SPI_ENABLED) || defined(DOXYGEN)
 
 #include <sta/spi/device.hpp>
 #include <sta/spi/interface.hpp>

include/sta/stm32/uart.hpp

@@ -22,7 +22,7 @@
 #endif // STA_PLATFORM_STM32
 
 
-#ifdef STA_STM32_UART_ENABLED
+#if defined(STA_STM32_UART_ENABLED) || defined(DOXYGEN)
 
 #include <sta/uart.hpp>