michaelh/zephyr
1
0
Fork 0
Code Releases Activity

tracing: format: improve Doxygen

Browse source 
- Add APIs to the `subsys_tracing` group
- Add some missing documentation
- Minor header file style fixes

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-11-05 13:21:25 +01:00 • committed by Christopher Friedt
commit c8b5b0c6fc
1 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

16
include/tracing/tracing_format.h
View file

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