X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dae2800ac82493e2f3cae2ce0231309a8e877683..f46e6a1ef9541a3d13c38a114870658d3b4e004b:/docs/doxygen/groups/funcmacro_debug.h

diff --git a/docs/doxygen/groups/funcmacro_debug.h b/docs/doxygen/groups/funcmacro_debug.h
index 74bc4819f5..b13ed8c4f3 100644
--- a/docs/doxygen/groups/funcmacro_debug.h
+++ b/docs/doxygen/groups/funcmacro_debug.h
@@ -3,24 +3,35 @@
 // Purpose:     Debugging function and macro group docs
 // Author:      wxWidgets team
 // RCS-ID:      $Id: funcmacro_gdi.h 52454 2008-03-12 19:08:48Z BP $
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
 
-@defgroup group_funcmacro_debug Debugging
+@defgroup group_funcmacro_debug Debugging macros
 @ingroup group_funcmacro
 
 Useful macros and functions for error checking and defensive programming.
-wxWidgets defines three families of the assert-like macros: the wxASSERT and
-wxFAIL macros only do anything if __WXDEBUG__ is defined (in other words, in
-the debug build) but disappear completely in the release build. On the other
-hand, the wxCHECK macros stay event in release builds but a check failure
-doesn't generate any user-visible effects then. Finally, the compile time
-assertions don't happen during the run-time but result in the compilation error
-messages if the condition they check fail.
-
-@header{wx/debug.h}
+
+Starting with wxWidgets 2.9.1, debugging support in wxWidgets is always
+compiled in by default, you need to explicitly define ::wxDEBUG_LEVEL as 0 to
+disable it completely. However, by default debugging macros are dormant in the
+release builds, i.e. when the main program is compiled with the standard @c
+NDEBUG symbol being defined. You may explicitly activate the debugging checks
+in the release build by calling wxSetAssertHandler() with a custom function if
+needed.
+
+When debugging support is active, failure of both wxASSERT() and wxCHECK()
+macros conditions result in a debug alert. When debugging support is inactive
+or turned off entirely at compilation time, wxASSERT() and wxFAIL() macros
+don't do anything while wxCHECK() still checks its condition and returns if it
+fails, even if no alerts are shown to the user.
+
+Finally, the compile time assertions don't happen during the run-time but
+result in the compilation error messages if the condition they check fail.
+They are always enabled and are not affected by ::wxDEBUG_LEVEL.
+
+Related class group: @ref group_class_debugging.
 
 */