doc: doxygen: add some subsystems to os_services group

Add the following root Doxygen modules under the umbrella of "OS Services" Doxygen group: - Cache - File system - IPC - RTIO - CRC - Iterable sections - ZBus - Task watchdog - Shell - Semihosting - Logging - System init Signed-off-by: Gerard Marull-Paretas <[email protected]>
phan-uy-vu · May 31, 2023 · 2481371 · 2481371
1 parent a98d673
commit 2481371
Show file tree

Hide file tree

Showing 12 changed files with 12 additions and 2 deletions.
diff --git a/include/zephyr/arch/common/semihost.h b/include/zephyr/arch/common/semihost.h
@@ -16,6 +16,7 @@
  *
  * @brief public Semihosting APIs based on ARM definitions.
  * @defgroup semihost Semihosting APIs
+ * @ingroup os_services
  * @{
  */
 

diff --git a/include/zephyr/cache.h b/include/zephyr/cache.h
@@ -30,6 +30,7 @@ extern "C" {
 
 /**
  * @defgroup cache_interface Cache Interface
+ * @ingroup os_services
  * @{
  */
 

diff --git a/include/zephyr/fs/fs.h b/include/zephyr/fs/fs.h
@@ -20,6 +20,7 @@ extern "C" {
 /**
  * @brief File System APIs
  * @defgroup file_system_api File System APIs
+ * @ingroup os_services
  * @{
  */
 struct fs_file_system_t;

diff --git a/include/zephyr/init.h b/include/zephyr/init.h
@@ -19,6 +19,7 @@ extern "C" {
 
 /**
  * @defgroup sys_init System Initialization
+ * @ingroup os_services
  *
  * Zephyr offers an infrastructure to call initialization code before `main`.
  * Such initialization calls can be registered using SYS_INIT() or

diff --git a/include/zephyr/ipc/ipc_service.h b/include/zephyr/ipc/ipc_service.h
@@ -18,6 +18,7 @@ extern "C" {
 /**
  * @brief IPC
  * @defgroup ipc IPC
+ * @ingroup os_services
  * @{
  * @}
  */

diff --git a/include/zephyr/logging/log.h b/include/zephyr/logging/log.h
@@ -18,6 +18,7 @@ extern "C" {
 /**
  * @brief Logging
  * @defgroup logging Logging
+ * @ingroup os_services
  * @{
  * @}
  */

diff --git a/include/zephyr/rtio/rtio.h b/include/zephyr/rtio/rtio.h
@@ -46,6 +46,7 @@ extern "C" {
 /**
  * @brief RTIO
  * @defgroup rtio RTIO
+ * @ingroup os_services
  * @{
  * @}
  */

diff --git a/include/zephyr/shell/shell.h b/include/zephyr/shell/shell.h
@@ -69,7 +69,7 @@ extern "C" {
 /**
  * @brief Shell API
  * @defgroup shell_api Shell API
- * @ingroup shell
+ * @ingroup os_services
  * @{
  */
 

diff --git a/include/zephyr/sys/crc.h b/include/zephyr/sys/crc.h
@@ -32,6 +32,7 @@ extern "C" {
 
 /**
  * @defgroup checksum Checksum
+ * @ingroup os_services
  */
 
 /**

diff --git a/include/zephyr/sys/iterable_sections.h b/include/zephyr/sys/iterable_sections.h
@@ -17,6 +17,7 @@ extern "C" {
 /**
  * @brief Iterable Sections APIs
  * @defgroup iterable_section_apis Iterable Sections APIs
+ * @ingroup os_services
  * @{
  */
 

diff --git a/include/zephyr/task_wdt/task_wdt.h b/include/zephyr/task_wdt/task_wdt.h
@@ -24,7 +24,7 @@
 /**
  * @brief Task Watchdog APIs
  * @defgroup task_wdt_api Task Watchdog APIs
- * @ingroup subsystem
+ * @ingroup os_services
  * @{
  */
 

diff --git a/include/zephyr/zbus/zbus.h b/include/zephyr/zbus/zbus.h
@@ -18,6 +18,7 @@ extern "C" {
 /**
  * @brief Zbus API
  * @defgroup zbus_apis Zbus APIs
+ * @ingroup os_services
  * @{
  */
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ @@
      *
      * @brief public Semihosting APIs based on ARM definitions.
      * @defgroup semihost Semihosting APIs
+     * @ingroup os_services
      * @{
      */
@@ Expand Down @@