michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: add kernel version API to doxygen

Browse source 
Put kernel version API into doxygen and make it available as a
documented API.

Fixes #6319

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2018-12-07 09:17:59 -05:00
commit 69c758436c
3 changed files with 25 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

18
include/kernel_version.h
View file

@ -13,7 +13,11 @@
extern "C" {
#endif
/*
/**
* @defgroup version_apis Version APIs
* @ingroup kernel_apis
* @{
*
* The kernel version has been converted from a string to a four-byte
* quantity that is divided into two parts.
*
@ -32,8 +36,20 @@ extern "C" {
/* kernel version routines */
/**
* @brief Return the kernel version of the present build
*
* The kernel version is a four-byte value, whose format is described in the
* file "kernel_version.h".
*
* @return kernel version
*/
extern u32_t sys_kernel_version_get(void);
/**
* @}
*/
#ifdef __cplusplus
}
#endif