doc: Add documentation for ASSERT and ASSERT2.

[bertos.git] / bertos / cfg / debug.h

diff --git a/bertos/cfg/debug.h b/bertos/cfg/debug.h
index 2fefc1b1468c68ed509503ec52c67abfc428c4c2..257682933d3fcf7576e79e8f2d68c79ab05e5066 100644 (file)
--- a/bertos/cfg/debug.h
+++ b/bertos/cfg/debug.h
@@ -30,13 +30,16 @@
  *
  * -->
  *
+ * \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"
@@ -161,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__)))
@@ -325,4 +334,6 @@
 
 #endif /* _DEBUG */
 
+/** \} */ // defgroup debug
+
 #endif /* BERTOS_DEBUG_H */