From 24157d68e4fa7bd3a1c9ba31abe4da276e7a7326 Mon Sep 17 00:00:00 2001 From: Giovanni Di Sirio Date: Fri, 4 May 2018 12:08:34 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11997 110e8d01-0319-4d1e-a829-52ad28d1bb01 --- doc/full_rm/Doxyfile_html | 1 + os/common/ports/ARM/compilers/GCC/chtypes.h | 18 ------------------ os/common/ports/ARMCMx/compilers/GCC/chtypes.h | 18 ------------------ os/common/ports/ARMCMx/compilers/RVCT/chtypes.h | 18 ------------------ os/common/ports/AVR/compilers/GCC/chtypes.h | 18 ------------------ os/common/ports/SIMIA32/compilers/GCC/chtypes.h | 18 ------------------ os/common/ports/e200/compilers/CW/chtypes.h | 18 ------------------ os/common/ports/e200/compilers/GCC/chtypes.h | 18 ------------------ os/common/ports/e200/compilers/GHS/chtypes.h | 18 ------------------ os/common/ports/templates/chcore.c | 6 +----- os/common/ports/templates/chcore.h | 2 +- os/common/ports/templates/chtypes.h | 22 ++-------------------- os/nil/include/ch.h | 20 ++++++++++++++++++++ os/rt/dox/rt.dox | 6 ------ 14 files changed, 25 insertions(+), 176 deletions(-) diff --git a/doc/full_rm/Doxyfile_html b/doc/full_rm/Doxyfile_html index c09e4b964..b0cf27fd0 100644 --- a/doc/full_rm/Doxyfile_html +++ b/doc/full_rm/Doxyfile_html @@ -799,6 +799,7 @@ INPUT = ./src \ ../../os/lib/dox \ ../../os/lib/src \ ../../os/lib/include \ + ../../os/common/ports/templates \ ../../os/hal/dox \ ../../os/hal/src \ ../../os/hal/include \ diff --git a/os/common/ports/ARM/compilers/GCC/chtypes.h b/os/common/ports/ARM/compilers/GCC/chtypes.h index 048101666..23c3b8e7b 100644 --- a/os/common/ports/ARM/compilers/GCC/chtypes.h +++ b/os/common/ports/ARM/compilers/GCC/chtypes.h @@ -32,24 +32,6 @@ #include #include -/** - * @name Common constants - */ -/** - * @brief Generic 'false' boolean constant. - */ -#if !defined(FALSE) || defined(__DOXYGEN__) -#define FALSE 0 -#endif - -/** - * @brief Generic 'true' boolean constant. - */ -#if !defined(TRUE) || defined(__DOXYGEN__) -#define TRUE 1 -#endif -/** @} */ - /** * @name Kernel types * @{ diff --git a/os/common/ports/ARMCMx/compilers/GCC/chtypes.h b/os/common/ports/ARMCMx/compilers/GCC/chtypes.h index 99c056951..de95804bf 100644 --- a/os/common/ports/ARMCMx/compilers/GCC/chtypes.h +++ b/os/common/ports/ARMCMx/compilers/GCC/chtypes.h @@ -32,24 +32,6 @@ #include #include -/** - * @name Common constants - */ -/** - * @brief Generic 'false' boolean constant. - */ -#if !defined(FALSE) || defined(__DOXYGEN__) -#define FALSE 0 -#endif - -/** - * @brief Generic 'true' boolean constant. - */ -#if !defined(TRUE) || defined(__DOXYGEN__) -#define TRUE 1 -#endif -/** @} */ - /** * @name Kernel types * @{ diff --git a/os/common/ports/ARMCMx/compilers/RVCT/chtypes.h b/os/common/ports/ARMCMx/compilers/RVCT/chtypes.h index 3acb61f13..fbda59762 100644 --- a/os/common/ports/ARMCMx/compilers/RVCT/chtypes.h +++ b/os/common/ports/ARMCMx/compilers/RVCT/chtypes.h @@ -32,24 +32,6 @@ #include #include -/** - * @name Common constants - */ -/** - * @brief Generic 'false' boolean constant. - */ -#if !defined(FALSE) || defined(__DOXYGEN__) -#define FALSE 0 -#endif - -/** - * @brief Generic 'true' boolean constant. - */ -#if !defined(TRUE) || defined(__DOXYGEN__) -#define TRUE (!FALSE) -#endif -/** @} */ - /** * @name Kernel types * @{ diff --git a/os/common/ports/AVR/compilers/GCC/chtypes.h b/os/common/ports/AVR/compilers/GCC/chtypes.h index 326558e1e..0bbb9ef9a 100644 --- a/os/common/ports/AVR/compilers/GCC/chtypes.h +++ b/os/common/ports/AVR/compilers/GCC/chtypes.h @@ -32,24 +32,6 @@ #include #include -/** - * @name Common constants - */ -/** - * @brief Generic 'false' boolean constant. - */ -#if !defined(FALSE) || defined(__DOXYGEN__) -#define FALSE 0 -#endif - -/** - * @brief Generic 'true' boolean constant. - */ -#if !defined(TRUE) || defined(__DOXYGEN__) -#define TRUE (!FALSE) -#endif -/** @} */ - /** * @name Kernel types * @{ diff --git a/os/common/ports/SIMIA32/compilers/GCC/chtypes.h b/os/common/ports/SIMIA32/compilers/GCC/chtypes.h index a246adb03..6ed1f04bc 100644 --- a/os/common/ports/SIMIA32/compilers/GCC/chtypes.h +++ b/os/common/ports/SIMIA32/compilers/GCC/chtypes.h @@ -32,24 +32,6 @@ #include #include -/** - * @name Common constants - */ -/** - * @brief Generic 'false' boolean constant. - */ -#if !defined(FALSE) || defined(__DOXYGEN__) -#define FALSE 0 -#endif - -/** - * @brief Generic 'true' boolean constant. - */ -#if !defined(TRUE) || defined(__DOXYGEN__) -#define TRUE 1 -#endif -/** @} */ - /** * @name Derived generic types * @{ diff --git a/os/common/ports/e200/compilers/CW/chtypes.h b/os/common/ports/e200/compilers/CW/chtypes.h index ded59d96e..22be82288 100644 --- a/os/common/ports/e200/compilers/CW/chtypes.h +++ b/os/common/ports/e200/compilers/CW/chtypes.h @@ -32,24 +32,6 @@ #include #include -/** - * @name Common constants - */ -/** - * @brief Generic 'false' boolean constant. - */ -#if !defined(FALSE) || defined(__DOXYGEN__) -#define FALSE 0 -#endif - -/** - * @brief Generic 'true' boolean constant. - */ -#if !defined(TRUE) || defined(__DOXYGEN__) -#define TRUE 1 -#endif -/** @} */ - /** * @name Kernel types * @{ diff --git a/os/common/ports/e200/compilers/GCC/chtypes.h b/os/common/ports/e200/compilers/GCC/chtypes.h index 10956e170..ae4d1162f 100644 --- a/os/common/ports/e200/compilers/GCC/chtypes.h +++ b/os/common/ports/e200/compilers/GCC/chtypes.h @@ -32,24 +32,6 @@ #include #include -/** - * @name Common constants - */ -/** - * @brief Generic 'false' boolean constant. - */ -#if !defined(FALSE) || defined(__DOXYGEN__) -#define FALSE 0 -#endif - -/** - * @brief Generic 'true' boolean constant. - */ -#if !defined(TRUE) || defined(__DOXYGEN__) -#define TRUE 1 -#endif -/** @} */ - /** * @name Kernel types * @{ diff --git a/os/common/ports/e200/compilers/GHS/chtypes.h b/os/common/ports/e200/compilers/GHS/chtypes.h index 10956e170..ae4d1162f 100644 --- a/os/common/ports/e200/compilers/GHS/chtypes.h +++ b/os/common/ports/e200/compilers/GHS/chtypes.h @@ -32,24 +32,6 @@ #include #include -/** - * @name Common constants - */ -/** - * @brief Generic 'false' boolean constant. - */ -#if !defined(FALSE) || defined(__DOXYGEN__) -#define FALSE 0 -#endif - -/** - * @brief Generic 'true' boolean constant. - */ -#if !defined(TRUE) || defined(__DOXYGEN__) -#define TRUE 1 -#endif -/** @} */ - /** * @name Kernel types * @{ diff --git a/os/common/ports/templates/chcore.c b/os/common/ports/templates/chcore.c index c0aed4793..217e49bfa 100644 --- a/os/common/ports/templates/chcore.c +++ b/os/common/ports/templates/chcore.c @@ -20,12 +20,8 @@ /** * @file templates/chcore.c * @brief Port related template code. - * @details This file is a template of the system driver functions provided by - * a port. Some of the following functions may be implemented as - * macros in chcore.h if the implementer decides that there is an - * advantage in doing so, for example because performance concerns. * - * @addtogroup core + * @addtogroup port_core * @details Non portable code templates. * @{ */ diff --git a/os/common/ports/templates/chcore.h b/os/common/ports/templates/chcore.h index c3dd0e5d3..98c4b9502 100644 --- a/os/common/ports/templates/chcore.h +++ b/os/common/ports/templates/chcore.h @@ -23,7 +23,7 @@ * @details This file is a template of the system driver macros provided by * a port. * - * @addtogroup core + * @addtogroup port_core * @{ */ diff --git a/os/common/ports/templates/chtypes.h b/os/common/ports/templates/chtypes.h index bf17f3003..fe30eff8c 100644 --- a/os/common/ports/templates/chtypes.h +++ b/os/common/ports/templates/chtypes.h @@ -20,12 +20,12 @@ /** * @file templates/chtypes.h * @brief System types template. + * + * @addtogroup port_types * @details The types defined in this file may change depending on the target * architecture. You may also try to optimize the size of the various * types in order to privilege size or performance, be careful in * doing so. - * - * @addtogroup types * @{ */ @@ -36,24 +36,6 @@ #include #include -/** - * @name Common constants - */ -/** - * @brief Generic 'false' boolean constant. - */ -#if !defined(FALSE) || defined(__DOXYGEN__) -#define FALSE 0 -#endif - -/** - * @brief Generic 'true' boolean constant. - */ -#if !defined(TRUE) || defined(__DOXYGEN__) -#define TRUE (!FALSE) -#endif -/** @} */ - /** * @name Kernel types * @{ diff --git a/os/nil/include/ch.h b/os/nil/include/ch.h index dc89bd597..3aa85af6c 100644 --- a/os/nil/include/ch.h +++ b/os/nil/include/ch.h @@ -73,6 +73,26 @@ #define CH_KERNEL_PATCH 0 /** @} */ +/** + * @name Constants for configuration options + */ +/** + * @brief Generic 'false' preprocessor boolean constant. + * @note It is meant to be used in configuration files as switch. + */ +#if !defined(FALSE) || defined(__DOXYGEN__) +#define FALSE 0 +#endif + +/** + * @brief Generic 'true' preprocessor boolean constant. + * @note It is meant to be used in configuration files as switch. + */ +#if !defined(TRUE) || defined(__DOXYGEN__) +#define TRUE 1 +#endif +/** @} */ + /** * @name Wakeup messages * @{ diff --git a/os/rt/dox/rt.dox b/os/rt/dox/rt.dox index 0002973ce..75030ff90 100644 --- a/os/rt/dox/rt.dox +++ b/os/rt/dox/rt.dox @@ -150,9 +150,3 @@ * @defgroup statistics Statistics * @ingroup debug */ - -/** - * @defgroup core Port Layer - * @ingroup kernel - */ - -- cgit v1.2.3