docs/doxygen/groups/funcmacro_debug.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        funcmacro_debug.h
   3 // Purpose:     Debugging function and macro group docs
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10
  11 @defgroup group_funcmacro_debug Debugging macros
  12 @ingroup group_funcmacro
  13
  14 Useful macros and functions for error checking and defensive programming.
  15 wxWidgets defines three families of the assert-like macros: the wxASSERT() and
  16 wxFAIL() macros only do anything if __WXDEBUG__ is defined (in other words, in
  17 the debug build) but disappear completely in the release build. On the other
  18 hand, the wxCHECK() macros stay in release builds but a check failure doesn't
  19 generate any user-visible effects. Finally, the compile time assertions don't
  20 happen during the run-time but result in the compilation error messages if the
  21 condition they check fail.
  22
  23 Related class group: @ref group_class_debugging.
  24
  25 */
  26