diff --git a/include/tracing/tracing_format.h b/include/tracing/tracing_format.h index 0da6dbfca06..303c963b600 100644 --- a/include/tracing/tracing_format.h +++ b/include/tracing/tracing_format.h @@ -14,8 +14,13 @@ extern "C" { #endif /** - * @brief A structure to represent tracing data format. + * @brief Tracing format APIs + * @defgroup subsys_tracing_format_apis Tracing format APIs + * @ingroup subsys_tracing + * @{ */ + +/** @brief A structure to represent tracing data format. */ typedef struct tracing_data { uint8_t *data; uint32_t length; @@ -23,6 +28,9 @@ typedef struct tracing_data { /** * @brief Macro to trace a message in string format. + * + * @param fmt The format string. + * @param ... The format arguments. */ #define TRACING_STRING(fmt, ...) \ do { \ @@ -31,6 +39,8 @@ typedef struct tracing_data { /** * @brief Macro to format data to tracing data format. + * + * @param x Data field. */ #define TRACING_FORMAT_DATA(x) \ ((struct tracing_data){.data = (uint8_t *)&(x), .length = sizeof((x))}) @@ -72,8 +82,10 @@ void tracing_format_raw_data(uint8_t *data, uint32_t length); */ void tracing_format_data(tracing_data_t *tracing_data_array, uint32_t count); +/** @} */ /* end of subsys_tracing_format_apis */ + #ifdef __cplusplus } #endif -#endif +#endif /* ZEPHYR_INCLUDE_TRACING_TRACING_FORMAT_H */