diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-05-03 11:19:35 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2018-05-03 11:19:35 +0000 |
| commit | 380a8d3808c38b2e3f2d97a3c2bf5094e0f0386a (patch) | |
| tree | 22aab283509cdf9af2c29fc1be16ce44cc3a3511 /os/rt/include | |
| parent | 1ceb50bebef5072a3686f225fe1d3aff5283fbda (diff) | |
| download | ChibiOS-380a8d3808c38b2e3f2d97a3c2bf5094e0f0386a.tar.gz ChibiOS-380a8d3808c38b2e3f2d97a3c2bf5094e0f0386a.tar.bz2 ChibiOS-380a8d3808c38b2e3f2d97a3c2bf5094e0f0386a.zip | |
Documentation-related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11988 110e8d01-0319-4d1e-a829-52ad28d1bb01
Diffstat (limited to 'os/rt/include')
| -rw-r--r-- | os/rt/include/ch.h | 4 | ||||
| -rw-r--r-- | os/rt/include/chalign.h | 1 | ||||
| -rw-r--r-- | os/rt/include/chchecks.h | 8 | ||||
| -rw-r--r-- | os/rt/include/chdebug.h | 2 | ||||
| -rw-r--r-- | os/rt/include/chtime.h | 35 |
5 files changed, 14 insertions, 36 deletions
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. */
/*===========================================================================*/
|