michaelh/zephyr
1
0
Fork 0
Code Releases Activity

arch: doxygen: group architecture interfaces

Browse source 
Group all architecture interfaces under one group in doxygen.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2019-10-25 08:29:50 -04:00
commit bad4c93318
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/sys/arch_interface.h
View file

@ -5,7 +5,7 @@
*/
/**
* @file
* @defgroup arch-interface Architecture Interface
* @brief Internal kernel APIs implemented at the architecture layer.
*
* Not all architecture-specific defines are here, APIs that are used
@ -31,6 +31,7 @@ extern "C" {
/**
* @defgroup arch-timing Architecture timing APIs
* @ingroup arch-interface
* @{
*/
#ifdef CONFIG_ARCH_HAS_CUSTOM_BUSY_WAIT
@ -46,6 +47,7 @@ void z_arch_busy_wait(u32_t usec_to_wait);
/**
* @defgroup arch-threads Architecture thread APIs
* @ingroup arch-interface
* @{
*/
@ -168,6 +170,7 @@ int z_arch_float_disable(struct k_thread *thread);
/**
* @defgroup arch-pm Architecture-specific power management APIs
* @ingroup arch-interface
* @{
*/
/** Halt the system, optionally propagating a reason code */
@ -178,6 +181,7 @@ FUNC_NORETURN void z_arch_system_halt(unsigned int reason);
/**
* @defgroup arch-smp Architecture-specific SMP APIs
* @ingroup arch-interface
* @{
*/
#ifdef CONFIG_SMP
@ -197,6 +201,7 @@ void z_arch_sched_ipi(void);
/**
* @defgroup arch-irq Architecture-specific IRQ APIs
* @ingroup arch-interface
* @{
*/
@ -215,6 +220,7 @@ static inline bool z_arch_is_in_isr(void);
/**
* @defgroup arch-userspace Architecture-specific userspace APIs
* @ingroup arch-interface
* @{
*/
#ifdef CONFIG_USERSPACE
@ -377,6 +383,7 @@ size_t z_arch_user_string_nlen(const char *s, size_t maxsize, int *err);
/**
* @defgroup arch-benchmarking Architecture-specific benchmarking globals
* @ingroup arch-interface
*/
#ifdef CONFIG_EXECUTION_BENCHMARKING
@ -397,6 +404,7 @@ extern u64_t z_arch_timing_value_swap_temp;
/**
* @defgroup arch-misc Miscellaneous architecture APIs
* @ingroup arch-interface
*/
/**