From 69c758436c2c20877e625884dce2ec03f3aef063 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Fri, 7 Dec 2018 09:17:59 -0500 Subject: [PATCH] doc: add kernel version API to doxygen Put kernel version API into doxygen and make it available as a documented API. Fixes #6319 Signed-off-by: Anas Nashif --- doc/api/kernel_api.rst | 8 ++++++++ include/kernel_version.h | 18 +++++++++++++++++- kernel/version.c | 3 --- 3 files changed, 25 insertions(+), 4 deletions(-) diff --git a/doc/api/kernel_api.rst b/doc/api/kernel_api.rst index 384d63e3bb3..2abf50a6c6a 100644 --- a/doc/api/kernel_api.rst +++ b/doc/api/kernel_api.rst @@ -241,6 +241,14 @@ of variable-size data items. :project: Zephyr :content-only: +Kernel Version +************** +Kernel version handling and APIs related to kernel version being used. + +.. doxygengroup:: version_apis + :project: Zephyr + :content-only: + Memory Domain ************* diff --git a/include/kernel_version.h b/include/kernel_version.h index d7df62773e0..23e2adb003d 100644 --- a/include/kernel_version.h +++ b/include/kernel_version.h @@ -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 diff --git a/kernel/version.c b/kernel/version.c index 0a680e80f65..a2b7cf09870 100644 --- a/kernel/version.c +++ b/kernel/version.c @@ -1,5 +1,3 @@ -/* version.c */ - /* * Copyright (c) 1997-2010, 2012-2014 Wind River Systems, Inc. * @@ -10,7 +8,6 @@ #include "version.h" /* generated by MAKE, at compile time */ /** - * * @brief Return the kernel version of the present build * * The kernel version is a four-byte value, whose format is described in the