Fix some doxygen warnings.
authorbatt <batt@38d2e660-2303-0410-9eaa-f027e97ec537>
Tue, 12 Aug 2008 07:57:35 +0000 (07:57 +0000)
committerbatt <batt@38d2e660-2303-0410-9eaa-f027e97ec537>
Tue, 12 Aug 2008 07:57:35 +0000 (07:57 +0000)
git-svn-id: https://src.develer.com/svnoss/bertos/trunk@1625 38d2e660-2303-0410-9eaa-f027e97ec537

bertos/cfg/nothing.h
bertos/cfg/test.h

index 0edfdc92c43494921e63c9c026342265930aebf3..4c18a1230e65f44256d58b60d0e866d331a36dba 100644 (file)
  * All Rights Reserved.
  * -->
  *
- * \brief Empty file used to #include <nothing> 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 <realheader.h>
+ * #else
+ *     #define MYHEADER <cfg/nothing.h>
+ * #endif
+ * \endcode
  *
  * \version $Id$
  *
  * \author Francesco Sacchi <batt@develer.com>
  */
+
index 507ec17e8a9c22bc628e31629365e8a5e7263226..a05db372fb6e0cab0a41cac86dc82e6f3440fe22 100644 (file)
  * 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.