From f17db1931e95f5ebb42f557b6eead2bf1320db5a Mon Sep 17 00:00:00 2001 From: gdisirio Date: Sat, 6 Feb 2010 10:55:53 +0000 Subject: Reformatted doxygen tags into the kernel sources to make them more readable. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@1567 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/kernel/include/ch.h | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) (limited to 'os/kernel/include/ch.h') 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 -- cgit v1.2.3