Skip to content

Commit 5e2977f

Browse files
bulislawadbridge
authored andcommitted
Fix doxygen for ITM HAL
1 parent 42e3be8 commit 5e2977f

File tree

3 files changed

+7
-10
lines changed

3 files changed

+7
-10
lines changed

doxyfile_options

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2070,6 +2070,7 @@ PREDEFINED = DOXYGEN_ONLY \
20702070
DEVICE_I2CSLAVE \
20712071
DEVICE_I2C_ASYNCH \
20722072
DEVICE_INTERRUPTIN \
2073+
DEVICE_ITM \
20732074
DEVICE_LOWPOWERTIMER \
20742075
DEVICE_PORTIN \
20752076
DEVICE_PORTINOUT \

doxygen_options.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"SEARCH_INCLUDES": "YES",
77
"INCLUDE_PATH": "",
88
"INCLUDE_FILE_PATTERNS": "",
9-
"PREDEFINED": "DOXYGEN_ONLY DEVICE_ANALOGIN DEVICE_ANALOGOUT DEVICE_CAN DEVICE_ETHERNET DEVICE_EMAC DEVICE_FLASH DEVICE_I2C DEVICE_I2CSLAVE DEVICE_I2C_ASYNCH DEVICE_INTERRUPTIN DEVICE_LOWPOWERTIMER DEVICE_PORTIN DEVICE_PORTINOUT DEVICE_PORTOUT DEVICE_PWMOUT DEVICE_RTC DEVICE_TRNG DEVICE_SERIAL DEVICE_SERIAL_ASYNCH DEVICE_SERIAL_FC DEVICE_SLEEP DEVICE_SPI DEVICE_SPI_ASYNCH DEVICE_SPISLAVE DEVICE_STORAGE \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\" \"MBED_DEPRECATED(s)=\"",
9+
"PREDEFINED": "DOXYGEN_ONLY DEVICE_ANALOGIN DEVICE_ANALOGOUT DEVICE_CAN DEVICE_ETHERNET DEVICE_EMAC DEVICE_FLASH DEVICE_I2C DEVICE_I2CSLAVE DEVICE_I2C_ASYNCH DEVICE_INTERRUPTIN DEVICE_ITM DEVICE_LOWPOWERTIMER DEVICE_PORTIN DEVICE_PORTINOUT DEVICE_PORTOUT DEVICE_PWMOUT DEVICE_RTC DEVICE_TRNG DEVICE_SERIAL DEVICE_SERIAL_ASYNCH DEVICE_SERIAL_FC DEVICE_SLEEP DEVICE_SPI DEVICE_SPI_ASYNCH DEVICE_SPISLAVE DEVICE_STORAGE \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\" \"MBED_DEPRECATED(s)=\"",
1010
"EXPAND_AS_DEFINED": "",
1111
"SKIP_FUNCTION_MACROS": "NO",
1212
"EXCLUDE_PATTERNS": "*/tools/* */targets/* */features/mbedtls/* */features/storage/* */features/unsupported/* */BUILD/* */rtos/TARGET_CORTEX/rtx*/* */cmsis/* */features/FEATURE_COMMON_PAL/* */features/FEATURE_LWIP/* */features/FEATURE_UVISOR/* */features/nanostack/* */ble/generic/* */ble/pal/*"

hal/itm_api.h

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
/** \addtogroup hal */
2+
/** @{*/
13
/* mbed Microcontroller Library
24
* Copyright (c) 2017 ARM Limited
35
*
@@ -26,22 +28,14 @@ extern "C" {
2628
#endif
2729

2830
/**
29-
* @defgroup hal_itm_port ITM Stimulus Ports
30-
*
31+
* \defgroup itm_hal Instrumented Trace Macrocell HAL API
3132
* @{
3233
*/
3334

3435
enum {
3536
ITM_PORT_SWO = 0
3637
};
3738

38-
/**@}*/
39-
40-
/**
41-
* \defgroup itm_hal Instrumented Trace Macrocell HAL API
42-
* @{
43-
*/
44-
4539
/**
4640
* @brief Target specific initialization function.
4741
* This function is responsible for initializing and configuring
@@ -89,3 +83,5 @@ uint32_t mbed_itm_send(uint32_t port, uint32_t data);
8983
#endif
9084

9185
#endif /* MBED_ITM_API_H */
86+
87+
/**@}*/

0 commit comments

Comments
 (0)