Skip to content

Commit

Permalink
kernel: doc: mark sections as internal in kernel.h
Browse files Browse the repository at this point in the history
Add doxygen conditionals around internal segments of the header.

Signed-off-by: Anas Nashif <[email protected]>
  • Loading branch information
nashif committed Sep 17, 2023
1 parent c4e190f commit a4de2eb
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions include/zephyr/kernel.h
Original file line number Diff line number Diff line change
Expand Up @@ -5814,6 +5814,7 @@ static inline void k_cpu_atomic_idle(unsigned int key)
*/

/**
* @cond INTERNAL_HIDDEN
* @internal
*/
#ifdef ARCH_EXCEPT
Expand All @@ -5840,6 +5841,9 @@ static inline void k_cpu_atomic_idle(unsigned int key)
} while (false)

#endif /* _ARCH__EXCEPT */
/**
* INTERNAL_HIDDEN @endcond
*/

/**
* @brief Fatally terminate a thread
Expand All @@ -5864,6 +5868,10 @@ static inline void k_cpu_atomic_idle(unsigned int key)
*/
#define k_panic() z_except_reason(K_ERR_KERNEL_PANIC)

/**
* @cond INTERNAL_HIDDEN
*/

/*
* private APIs that are utilized by one or more public APIs
*/
Expand Down Expand Up @@ -5901,6 +5909,9 @@ void z_smp_thread_swap(void);
* @internal
*/
extern void z_timer_expiration_handler(struct _timeout *t);
/**
* INTERNAL_HIDDEN @endcond
*/

#ifdef CONFIG_PRINTK
/**
Expand Down

0 comments on commit a4de2eb

Please sign in to comment.