core/xfa: fix doxygen issues

This commit is contained in:
Kaspar Schleiser 2020-12-08 16:10:44 +01:00
parent 249ed5f2e1
commit d310044a88

View File

@ -28,7 +28,9 @@
* index out of bounds" warning. So until a solution for that is found, we * index out of bounds" warning. So until a solution for that is found, we
* need to disable array bounds checks for files using XFAs. * need to disable array bounds checks for files using XFAs.
*/ */
#ifndef DOXYGEN
_Pragma("GCC diagnostic ignored \"-Warray-bounds\"") _Pragma("GCC diagnostic ignored \"-Warray-bounds\"")
#endif
/** /**
* @brief helper macro for other XFA_* macros * @brief helper macro for other XFA_* macros
@ -129,7 +131,7 @@ _Pragma("GCC diagnostic ignored \"-Warray-bounds\"")
* *
* XFA(driver_params, 0) driver_params_t _onboard = { .pin=42 }; * XFA(driver_params, 0) driver_params_t _onboard = { .pin=42 };
* *
* @param[in] name name of the xfa * @param[in] xfa_name name of the xfa
* @param[in] prio priority within the xfa * @param[in] prio priority within the xfa
*/ */
#define XFA(xfa_name, prio) _XFA(xfa_name, 5_ ## prio) #define XFA(xfa_name, prio) _XFA(xfa_name, 5_ ## prio)
@ -143,7 +145,7 @@ _Pragma("GCC diagnostic ignored \"-Warray-bounds\"")
* *
* XFA(driver_params, 0) driver_params_t _onboard = { .pin=42 }; * XFA(driver_params, 0) driver_params_t _onboard = { .pin=42 };
* *
* @param[in] name name of the xfa * @param[in] xfa_name name of the xfa
* @param[in] prio priority within the xfa * @param[in] prio priority within the xfa
*/ */
#define XFA_CONST(xfa_name, prio) _XFA_CONST(xfa_name, 5_ ## prio) #define XFA_CONST(xfa_name, prio) _XFA_CONST(xfa_name, 5_ ## prio)
@ -177,5 +179,5 @@ extern "C" {
} }
#endif #endif
/** @} */
#endif /* XFA_H */ #endif /* XFA_H */
/** @} */