Skip to content

Commit 69c7584

Browse files
committed
doc: add kernel version API to doxygen
Put kernel version API into doxygen and make it available as a documented API. Fixes zephyrproject-rtos#6319 Signed-off-by: Anas Nashif <[email protected]>
1 parent 57b28ca commit 69c7584

File tree

3 files changed

+25
-4
lines changed

3 files changed

+25
-4
lines changed

doc/api/kernel_api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,14 @@ of variable-size data items.
241241
:project: Zephyr
242242
:content-only:
243243

244+
Kernel Version
245+
**************
246+
Kernel version handling and APIs related to kernel version being used.
247+
248+
.. doxygengroup:: version_apis
249+
:project: Zephyr
250+
:content-only:
251+
244252
Memory Domain
245253
*************
246254

include/kernel_version.h

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,11 @@
1313
extern "C" {
1414
#endif
1515

16-
/*
16+
/**
17+
* @defgroup version_apis Version APIs
18+
* @ingroup kernel_apis
19+
* @{
20+
*
1721
* The kernel version has been converted from a string to a four-byte
1822
* quantity that is divided into two parts.
1923
*
@@ -32,8 +36,20 @@ extern "C" {
3236

3337
/* kernel version routines */
3438

39+
/**
40+
* @brief Return the kernel version of the present build
41+
*
42+
* The kernel version is a four-byte value, whose format is described in the
43+
* file "kernel_version.h".
44+
*
45+
* @return kernel version
46+
*/
3547
extern u32_t sys_kernel_version_get(void);
3648

49+
/**
50+
* @}
51+
*/
52+
3753
#ifdef __cplusplus
3854
}
3955
#endif

kernel/version.c

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
/* version.c */
2-
31
/*
42
* Copyright (c) 1997-2010, 2012-2014 Wind River Systems, Inc.
53
*
@@ -10,7 +8,6 @@
108
#include "version.h" /* generated by MAKE, at compile time */
119

1210
/**
13-
*
1411
* @brief Return the kernel version of the present build
1512
*
1613
* The kernel version is a four-byte value, whose format is described in the

0 commit comments

Comments
 (0)