X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fcfg%2Fdebug.h;fp=bertos%2Fcfg%2Fdebug.h;h=257682933d3fcf7576e79e8f2d68c79ab05e5066;hb=c2dceae6e510636a81423abf8af27e4244b0d850;hp=cccaf8ccee6c394586522c8426a2867c4dd3de6c;hpb=5ce106d6d92a54a113656bfb201f91d51b194028;p=bertos.git diff --git a/bertos/cfg/debug.h b/bertos/cfg/debug.h index cccaf8cc..25768293 100644 --- a/bertos/cfg/debug.h +++ b/bertos/cfg/debug.h @@ -30,6 +30,10 @@ * * --> * + * \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. @@ -160,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__))) @@ -324,4 +334,6 @@ #endif /* _DEBUG */ +/** \} */ // defgroup debug + #endif /* BERTOS_DEBUG_H */