X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fcfg%2Fdebug.h;h=257682933d3fcf7576e79e8f2d68c79ab05e5066;hb=d86a921be38f9dfe999bfd36bc3a8e76a2ad929f;hp=4aa33639d5765d3cf4c87461bf41aecb826d563c;hpb=111a5049211f2adee08a0e483bfd560f3ee88e14;p=bertos.git

diff --git a/bertos/cfg/debug.h b/bertos/cfg/debug.h
index 4aa33639..25768293 100644
--- a/bertos/cfg/debug.h
+++ b/bertos/cfg/debug.h
@@ -30,14 +30,23 @@
  *
  * -->
  *
+ * \defgroup debug Debugging facilities and macros
+ * \ingroup core
+ * \{
+ *
  * \brief Simple debug facilities for hosted and embedded C/C++ applications.
  *
  * Debug output goes to stderr in hosted applications.
  * Freestanding (AKA embedded) applications use \c drv/kdebug.c to output
  * diagnostic messages to a serial terminal or a JTAG debugger.
  *
- * \version $Id$
  * \author Bernie Innocenti <bernie@codewiz.org>
+ *
+ * $WIZ$ module_name = "debug"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_debug.h"
+ * $WIZ$ DEBUG = 1
+ * $WIZ$ module_depends = "formatwr"
+ * $WIZ$ module_supports = "not atmega103"
  */
 
 #ifndef BERTOS_DEBUG_H
@@ -155,7 +164,13 @@
 	#endif /* !CPU_HARVARD */
 
 	#if !CONFIG_KDEBUG_ASSERT_NO_TEXT
+		/**
+		 * Assert a pre-condition on code.
+		 */
 		#define ASSERT(x)         ((void)(LIKELY(x) ? 0 : __bassert(#x, THIS_FILE, __LINE__)))
+		/**
+		 * Assert a pre-condition and give explanation message when assert fails
+		 */
 		#define ASSERT2(x, help)  ((void)(LIKELY(x) ? 0 : __bassert(help " (" #x ")", THIS_FILE, __LINE__)))
 	#else
 		#define ASSERT(x)         ((void)(LIKELY(x) ? 0 : __bassert("", THIS_FILE, __LINE__)))
@@ -319,4 +334,6 @@
 
 #endif /* _DEBUG */
 
+/** \} */ // defgroup debug
+
 #endif /* BERTOS_DEBUG_H */