[wxWidgets.git] / docs / doxygen / groups / funcmacro_debug.h

/////////////////////////////////////////////////////////////////////////////
// Name:        funcmacro_debug.h
// 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
/////////////////////////////////////////////////////////////////////////////

/**

@defgroup group_funcmacro_debug Debugging
@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}

*/
Commit	Line	Data
dae2800a BP	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 license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10
	11	@defgroup group_funcmacro_debug Debugging
	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 event in release builds but a check failure
	19	doesn't generate any user-visible effects then. Finally, the compile time
	20	assertions don't happen during the run-time but result in the compilation error
	21	messages if the condition they check fail.
	22
	23	@header{wx/debug.h}
	24
	25	*/
	26