aboutsummaryrefslogtreecommitdiffstats
path: root/os/kernel/include/ch.h
diff options
context:
space:
mode:
Diffstat (limited to 'os/kernel/include/ch.h')
-rw-r--r--os/kernel/include/ch.h17
1 files changed, 10 insertions, 7 deletions
diff --git a/os/kernel/include/ch.h b/os/kernel/include/ch.h
index 109040262..0607e2d52 100644
--- a/os/kernel/include/ch.h
+++ b/os/kernel/include/ch.h
@@ -18,8 +18,11 @@
*/
/**
- * @file ch.h
- * @brief ChibiOS/RT main include file, it includes everything else.
+ * @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
* @{
*/
@@ -28,27 +31,27 @@
#define _CH_H_
/**
- * ChibiOS/RT identification macro.
+ * @brief ChibiOS/RT identification macro.
*/
#define _CHIBIOS_RT_
/**
- * Kernel version string.
+ * @brief Kernel version string.
*/
#define CH_KERNEL_VERSION "1.5.1unstable"
/**
- * Kernel version major number.
+ * @brief Kernel version major number.
*/
#define CH_KERNEL_MAJOR 1
/**
- * Kernel version minor number.
+ * @brief Kernel version minor number.
*/
#define CH_KERNEL_MINOR 5
/**
- * Kernel version patch number.
+ * @brief Kernel version patch number.
*/
#define CH_KERNEL_PATCH 1