Skip to content

Commit 8fe2395

Browse files
nashifkartben
authored andcommitted
doc: doxygen: add @brief to few APIs
Add some clarity to some of the groups using @brief. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
1 parent 3dc7291 commit 8fe2395

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

include/zephyr/arch/arch_interface.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1259,6 +1259,7 @@ void arch_spin_relax(void);
12591259
/**
12601260
* @defgroup arch-stackwalk Architecture-specific Stack Walk APIs
12611261
* @ingroup arch-interface
1262+
* @brief Architecture-specific Stack Walk APIs
12621263
*
12631264
* To add API support to an architecture, `arch_stack_walk()` should be implemented and a non-user
12641265
* configurable Kconfig `ARCH_HAS_STACKWALK` that is default to `y` should be created in the

include/zephyr/kernel.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5801,6 +5801,7 @@ void k_heap_free(struct k_heap *h, void *mem) __attribute_nonnull(1);
58015801

58025802
/**
58035803
* @defgroup heap_apis Heap APIs
5804+
* @brief Memory allocation from the Heap
58045805
* @ingroup kernel_apis
58055806
* @{
58065807
*/
@@ -5958,6 +5959,8 @@ enum _poll_states_bits {
59585959

59595960
/**
59605961
* @defgroup poll_apis Async polling APIs
5962+
* @brief An API to wait concurrently for any one of multiple conditions to be
5963+
* fulfilled
59615964
* @ingroup kernel_apis
59625965
* @{
59635966
*/

include/zephyr/kernel_version.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ extern "C" {
1818
* @ingroup kernel_apis
1919
* @{
2020
*
21+
* @brief Kernel Version APIs
22+
*
2123
* The kernel version has been converted from a string to a four-byte
2224
* quantity that is divided into two parts.
2325
*

0 commit comments

Comments
 (0)