// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
-/*!
+/**
- @page overview_debugging Debugging overview
+ @page overview_debugging Debugging
- Classes, functions and macros: #wxDebugContext, #wxObject, #wxLog,
- @ref overview_logfunctions, @ref overview_debugmacros
+ Classes, functions and macros: wxDebugContext, wxObject, wxLog,
+ @ref page_func_cat_log, @ref page_macro_cat_debugging
Various classes, functions and macros are provided in wxWidgets to help you debug
your application. Most of these are only available if you compile both wxWidgets,
defined. You can also test the __WXDEBUG__ symbol in your own applications to execute
code that should be active only in debug mode.
+ @li @ref overview_debugging_dbgctx
+ @li @ref overview_debugging_dbgmacros
+ @li @ref overview_debugging_logging
+ @li @ref overview_debugging_dbgctx2
+
+
+ <hr>
@section overview_debugging_dbgctx wxDebugContext
- #wxDebugContext is a class that never gets instantiated, but ties together
+ wxDebugContext is a class that never gets instantiated, but ties together
various static functions and variables. It allows you to dump all objects to that stream,
write statistics about object allocation, and check memory for errors.
@section overview_debugging_dbgmacros Debug macros
- You should also use @ref debugmacros_overview as part of a 'defensive programming' strategy,
- scattering wxASSERTs liberally to test for problems in your code as early as possible.
+ You should also use @ref page_macro_cat_debugging as part of a 'defensive programming'
+ strategy, scattering wxASSERTs liberally to test for problems in your code as early as
+ possible.
Forward thinking will save a surprising amount of time in the long run.
#wxASSERT is used to pop up an error message box when a condition
@section overview_debugging_logging Logging functions
- You can use the #wxLogDebug and #wxLogTrace functions to output debugging information in
+ You can use the wxLogDebug and wxLogTrace functions to output debugging information in
debug mode; it will do nothing for non-debugging code.
@section overview_debugging_dbgctx2 wxDebugContext overview
- Class: #wxDebugContext
+ Class: wxDebugContext
wxDebugContext is a class for performing various debugging and memory tracing operations.