From bad932366898b7153f2cba75c06cec2d86f35fe1 Mon Sep 17 00:00:00 2001 From: batt Date: Tue, 12 Aug 2008 07:57:35 +0000 Subject: [PATCH] Fix some doxygen warnings. git-svn-id: https://src.develer.com/svnoss/bertos/trunk@1625 38d2e660-2303-0410-9eaa-f027e97ec537 --- bertos/cfg/nothing.h | 14 +++++++++++++- bertos/cfg/test.h | 2 ++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/bertos/cfg/nothing.h b/bertos/cfg/nothing.h index 0edfdc92..4c18a123 100644 --- a/bertos/cfg/nothing.h +++ b/bertos/cfg/nothing.h @@ -30,9 +30,21 @@ * All Rights Reserved. * --> * - * \brief Empty file used to #include in macro expansion. + * \brief Empty file used to include "nothing" in macro expansion. + * + * If you want to conditionally include some file you can use this module + * as a dummy header: + * + * \code + * #if COND + * #define MYHEADER + * #else + * #define MYHEADER + * #endif + * \endcode * * \version $Id$ * * \author Francesco Sacchi */ + diff --git a/bertos/cfg/test.h b/bertos/cfg/test.h index 507ec17e..a05db372 100644 --- a/bertos/cfg/test.h +++ b/bertos/cfg/test.h @@ -48,11 +48,13 @@ * All of these should return 0 if ok or a value != 0 on errors. * * Then, at the end of your module_test you can write: + * \code * #include TEST_ONLY(whatuneed.h) * #include TEST_ONLY(whatuneed.c) * #include TEST_ONLY(...) * * TEST_MAIN(module); + * \endcode * * The macro TEST_ONLY expand to nothing in non-TEST mode or to * the specified filename if _TEST is defined. -- 2.25.1