From ec405a86323da58876ddf1cd481cacf11175bc26 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Wed, 16 Apr 2025 08:09:49 -0400 Subject: [PATCH] doc: doxygen: group debugging APIs Create new group for debugging and move all debugging APIs under this group. Signed-off-by: Anas Nashif --- doc/_doxygen/groups.dox | 6 ++++++ include/zephyr/debug/coredump.h | 2 +- include/zephyr/debug/coresight/cs_trace_defmt.h | 1 + include/zephyr/debug/cpu_load.h | 2 +- include/zephyr/debug/mipi_stp_decoder.h | 2 +- include/zephyr/debug/symtab.h | 2 +- include/zephyr/debug/thread_analyzer.h | 2 +- 7 files changed, 12 insertions(+), 5 deletions(-) diff --git a/doc/_doxygen/groups.dox b/doc/_doxygen/groups.dox index 38edbb052b2..20b58037c57 100644 --- a/doc/_doxygen/groups.dox +++ b/doc/_doxygen/groups.dox @@ -39,6 +39,12 @@ @{ @} +@brief Debug Services +@defgroup debug Debug +@ingroup os_services +@{ +@} + @brief Connectivity @defgroup connectivity Connectivity @{ diff --git a/include/zephyr/debug/coredump.h b/include/zephyr/debug/coredump.h index a4fa4aa5d97..bf045763c45 100644 --- a/include/zephyr/debug/coredump.h +++ b/include/zephyr/debug/coredump.h @@ -29,7 +29,7 @@ * @file * * @defgroup coredump_apis Coredump APIs - * @ingroup os_services + * @ingroup debug * @brief Coredump APIs * @{ */ diff --git a/include/zephyr/debug/coresight/cs_trace_defmt.h b/include/zephyr/debug/coresight/cs_trace_defmt.h index b9920672681..b106586ca2b 100644 --- a/include/zephyr/debug/coresight/cs_trace_defmt.h +++ b/include/zephyr/debug/coresight/cs_trace_defmt.h @@ -14,6 +14,7 @@ extern "C" { /** * @defgroup coresight_apis Coresight APIs + * @ingroup debug * @{ * @} * @defgroup cs_trace_defmt Coresight Trace Deformatter diff --git a/include/zephyr/debug/cpu_load.h b/include/zephyr/debug/cpu_load.h index 5e5c28b379b..dbc816fd227 100644 --- a/include/zephyr/debug/cpu_load.h +++ b/include/zephyr/debug/cpu_load.h @@ -14,7 +14,7 @@ extern "C" { #endif /** @defgroup cpu_load CPU load monitor - * @ingroup os_services + * @ingroup debug * @brief Module for monitoring CPU Load * * This module allow monitoring of the CPU load. diff --git a/include/zephyr/debug/mipi_stp_decoder.h b/include/zephyr/debug/mipi_stp_decoder.h index c3a87e7a2ff..a28ecff83db 100644 --- a/include/zephyr/debug/mipi_stp_decoder.h +++ b/include/zephyr/debug/mipi_stp_decoder.h @@ -15,7 +15,7 @@ extern "C" { /** * @defgroup mipi_stp_decoder_apis STP Decoder API - * @ingroup os_services + * @ingroup debug * @{ */ diff --git a/include/zephyr/debug/symtab.h b/include/zephyr/debug/symtab.h index 19afb5947b8..c83d2ba1948 100644 --- a/include/zephyr/debug/symtab.h +++ b/include/zephyr/debug/symtab.h @@ -15,7 +15,7 @@ extern "C" { /** * @defgroup symtab_apis Symbol Table API - * @ingroup os_services + * @ingroup debug * @{ */ diff --git a/include/zephyr/debug/thread_analyzer.h b/include/zephyr/debug/thread_analyzer.h index d3d419bd8b6..c89607ab6a2 100644 --- a/include/zephyr/debug/thread_analyzer.h +++ b/include/zephyr/debug/thread_analyzer.h @@ -15,7 +15,7 @@ extern "C" { #endif /** @defgroup thread_analyzer Thread analyzer - * @ingroup os_services + * @ingroup debug * @brief Module for analyzing threads * * This module implements functions and the configuration that simplifies