From 380a8d3808c38b2e3f2d97a3c2bf5094e0f0386a Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Thu, 3 May 2018 11:19:35 +0000 Subject: Documentation-related fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11988 110e8d01-0319-4d1e-a829-52ad28d1bb01 --- os/rt/dox/rt.dox | 78 ++++++++++++++++++++---------------------------- os/rt/include/ch.h | 4 +-- os/rt/include/chalign.h | 1 + os/rt/include/chchecks.h | 8 +++++ os/rt/include/chdebug.h | 2 +- os/rt/include/chtime.h | 35 ++-------------------- os/rt/src/chdebug.c | 4 +-- 7 files changed, 48 insertions(+), 84 deletions(-) (limited to 'os/rt') diff --git a/os/rt/dox/rt.dox b/os/rt/dox/rt.dox index 76b055761..bd19984ba 100644 --- a/os/rt/dox/rt.dox +++ b/os/rt/dox/rt.dox @@ -29,10 +29,20 @@ */ /** - * @defgroup config Configuration + * @defgroup config_category Configuration * @ingroup kernel */ +/** + * @defgroup config Options + * @ingroup config_category + */ + +/** + * @defgroup conf_checks Checks + * @ingroup config_category + */ + /** * @defgroup checks License Checks * @ingroup kernel @@ -45,6 +55,11 @@ * @ingroup kernel */ +/** + * @defgroup mem Memory Alignment + * @ingroup base + */ + /** * @defgroup system System Management * @ingroup base @@ -55,13 +70,23 @@ * @ingroup base */ +/** + * @defgroup time_intervals Time and Intervals + * @ingroup base + */ + +/** + * @defgroup time Virtual Timers + * @ingroup base + */ + /** * @defgroup threads Threads * @ingroup base */ /** - * @defgroup time Time and Virtual Timers + * @defgroup time_measurement Time Measurement * @ingroup base */ @@ -76,11 +101,6 @@ * @ingroup synchronization */ -/** - * @defgroup binary_semaphores Binary Semaphores - * @ingroup synchronization - */ - /** * @defgroup mutexes Mutexes * @ingroup synchronization @@ -101,41 +121,9 @@ * @ingroup synchronization */ -/** - * @defgroup mailboxes Mailboxes - * @ingroup synchronization - */ - -/** - * @defgroup mem Memory Alignment - * @details Memory Alignment services. - * @ingroup kernel - */ - -/** - * @defgroup memory Memory Management - * @details Memory Management services. - * @ingroup kernel - */ - -/** - * @defgroup memcore Core Memory Manager - * @ingroup memory - */ - -/** - * @defgroup heaps Heaps - * @ingroup memory - */ - -/** - * @defgroup pools Memory Pools - * @ingroup memory - */ - /** * @defgroup dynamic_threads Dynamic Threads - * @ingroup memory + * @ingroup kernel */ /** @@ -149,18 +137,18 @@ */ /** - * @defgroup trace Trace - * @ingroup kernel + * @defgroup checks_assertions Checks and Assertions + * @ingroup debug */ /** - * @defgroup time_measurement Time Measurement - * @ingroup kernel + * @defgroup trace Tracing + * @ingroup debug */ /** * @defgroup statistics Statistics - * @ingroup kernel + * @ingroup debug */ /** diff --git a/os/rt/include/ch.h b/os/rt/include/ch.h index a4b6eb257..99eb0d2ab 100644 --- a/os/rt/include/ch.h +++ b/os/rt/include/ch.h @@ -20,10 +20,10 @@ /** * @file ch.h * @brief ChibiOS/RT main include file. - * @details This header includes all the required kernel headers so it is the - * only kernel header you usually want to include in your application. * * @addtogroup kernel_info + * @details This header includes all the required kernel headers so it is the + * only kernel header you usually want to include in your application. * @details Kernel related info. * @{ */ diff --git a/os/rt/include/chalign.h b/os/rt/include/chalign.h index 253b7b315..1d138e895 100644 --- a/os/rt/include/chalign.h +++ b/os/rt/include/chalign.h @@ -22,6 +22,7 @@ * @brief Memory alignment macros and structures. * * @addtogroup mem + * @details Memory Alignment services. * @{ */ diff --git a/os/rt/include/chchecks.h b/os/rt/include/chchecks.h index 5c38757cd..a1ca063a6 100644 --- a/os/rt/include/chchecks.h +++ b/os/rt/include/chchecks.h @@ -20,6 +20,12 @@ /** * @file chchecks.h * @brief Configuration file checks header. + * + * @addtogroup conf_checks + * @details This module performs a series of checks on configuration data, + * it is able to detect and reject obsolete or incomplete + * @p chconf.h files. + * @{ */ #ifndef CHCHECKS_H @@ -253,3 +259,5 @@ /*===========================================================================*/ #endif /* CHCHECKS_H */ + +/** @} */ diff --git a/os/rt/include/chdebug.h b/os/rt/include/chdebug.h index 43163bed1..f8a362d5c 100644 --- a/os/rt/include/chdebug.h +++ b/os/rt/include/chdebug.h @@ -21,7 +21,7 @@ * @file chdebug.h * @brief Debug support macros and structures. * - * @addtogroup debug + * @addtogroup checks_assertions * @{ */ diff --git a/os/rt/include/chtime.h b/os/rt/include/chtime.h index c975d104b..264ebcde3 100644 --- a/os/rt/include/chtime.h +++ b/os/rt/include/chtime.h @@ -22,6 +22,8 @@ * @brief Time and intervals macros and structures. * * @addtogroup time_intervals + * @details This module is responsible for handling of system time and time + * intervals. * @{ */ @@ -67,39 +69,6 @@ /* Module pre-compile time settings. */ /*===========================================================================*/ -/** - * @brief System time counter resolution. - * @note Allowed values are 16, 32 or 64 bits. - */ -#if !defined(CH_CFG_ST_RESOLUTION) || defined(__DOXYGEN__) -#define CH_CFG_ST_RESOLUTION 32 -#endif - -/** - * @brief System tick frequency. - * @details Frequency of the system timer that drives the system ticks. This - * setting also defines the system tick time unit. - */ -#if !defined(CH_CFG_ST_FREQUENCY) || defined(__DOXYGEN__) -#define CH_CFG_ST_FREQUENCY 1000 -#endif - -/** - * @brief Time intervals data size. - * @note Allowed values are 16, 32 or 64 bits. - */ -#if !defined(CH_CFG_INTERVALS_SIZE) || defined(__DOXYGEN__) -#define CH_CFG_INTERVALS_SIZE 32 -#endif - -/** - * @brief Time types data size. - * @note Allowed values are 16 or 32 bits. - */ -#if !defined(CH_CFG_TIME_TYPES_SIZE) || defined(__DOXYGEN__) -#define CH_CFG_TIME_TYPES_SIZE 32 -#endif - /*===========================================================================*/ /* Derived constants and error checks. */ /*===========================================================================*/ diff --git a/os/rt/src/chdebug.c b/os/rt/src/chdebug.c index 64e325349..2b4f05452 100644 --- a/os/rt/src/chdebug.c +++ b/os/rt/src/chdebug.c @@ -21,7 +21,7 @@ * @file chdebug.c * @brief Debug support code. * - * @addtogroup debug + * @addtogroup checks_assertions * @details Debug APIs and services: * - Runtime system state and call protocol check. The following * panic messages can be generated: @@ -69,10 +69,8 @@ * - S-class function not called from within a critical zone. * - Called from an ISR. * . - * - Trace buffer. * - Parameters check. * - Kernel assertions. - * - Kernel panics. * . * @note Stack checks are not implemented in this module but in the port * layer in an architecture-dependent way. -- cgit v1.2.3