zephyr/include/zephyr/debug/object_tracing.h
Gerard Marull-Paretas a7c3e7e84a doxygen: remove redundant usages of def
The def command Indicates that a comment block contains documentation
for a #define macro. This is useful if the comment block documents a
macro not adjacent to it, e.g.

```c
/**
 * @def MAX(x,y)
 * @brief Computes the maximum of @a x and @a y.
 */
 #ifdef XXX
 #define MAX(x,y) ...
 #endif
```

However, it is not necessary if the comment is adjacent to the
definition, e.g.

```c
/**
 * @brief Computes the maximum of @a x and @a y.
 */
 #define MAX(x,y) ...
```

This patch removes all unnecessary def entries in-tree.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-08-09 12:29:28 +02:00

32 lines
760 B
C

/*
* Copyright (c) 2016 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef ZEPHYR_INCLUDE_THREAD_MONITOR_H_
#define ZEPHYR_INCLUDE_THREAD_MONITOR_H_
#include <zephyr/kernel.h>
#include <zephyr/kernel_structs.h>
/**
* @brief Head element of the thread monitor list.
*
* @details Access the head element of the thread monitor list.
*
*/
#define SYS_THREAD_MONITOR_HEAD ((struct k_thread *)(_kernel.threads))
/**
* @brief Gets a thread node's next element.
*
* @details Given a node in a thread monitor list, gets the next
* element in the list.
*
* @param obj Object to get the next element from.
*/
#define SYS_THREAD_MONITOR_NEXT(obj) (((struct k_thread *)obj)->next_thread)
#endif /* ZEPHYR_INCLUDE_THREAD_MONITOR_H_ */