michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: generate documentation of ifdef`ed APIs

Browse source 
Enable generation of doxygen documentation for kernel APIs that are
behind Kconfig options and add a note about the option needed to enable
the APIs.

Enable both CONFIG_SCHED_CPU_MASK and CONFIG_SCHED_DEADLINE in doxygen
config file.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-06-10 12:25:50 -04:00
commit 240c516316
2 changed files with 32 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

30
include/kernel.h
View file

@ -1043,6 +1043,12 @@ __syscall void k_thread_priority_set(k_tid_t thread, int prio);
* above this call, which is simply input to the priority selection
* logic.
*
* @note
* @rststar
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
*
* @param thread A thread on which to set the deadline
* @param deadline A time delta, in cycle units
*
@ -1058,6 +1064,12 @@ __syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
* After this returns, the thread will no longer be schedulable on any
* CPUs. The thread must not be currently runnable.
*
* @note
* @rststar
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
*
* @param thread Thread to operate upon
* @return Zero on success, otherwise error code
*/
@ -1069,6 +1081,12 @@ int k_thread_cpu_mask_clear(k_tid_t thread);
* After this returns, the thread will be schedulable on any CPU. The
* thread must not be currently runnable.
*
* @note
* @rststar
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
*
* @param thread Thread to operate upon
* @return Zero on success, otherwise error code
*/
@ -1079,6 +1097,12 @@ int k_thread_cpu_mask_enable_all(k_tid_t thread);
*
* The thread must not be currently runnable.
*
* @note
* @rststar
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
*
* @param thread Thread to operate upon
* @param cpu CPU index
* @return Zero on success, otherwise error code
@ -1090,6 +1114,12 @@ int k_thread_cpu_mask_enable(k_tid_t thread, int cpu);
*
* The thread must not be currently runnable.
*
* @note
* @rststar
* You should enable :option:`CONFIG_SCHED_DEADLINE` in your project
* configuration.
* @endrststar
*
* @param thread Thread to operate upon
* @param cpu CPU index
* @return Zero on success, otherwise error code