]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/overviews/debugging.h
Fix column sorting UI in wxDataViewCtrl under wxOSX.
[wxWidgets.git] / docs / doxygen / overviews / debugging.h
index 108f00c08488c936a3133e87567c8ba455ccbf3f..32a0013b83feb1712c15f66e8c3bf711f9036c12 100644 (file)
@@ -3,27 +3,29 @@
 // Purpose:     topic overview
 // Author:      Vadim Zeitlin
 // Copyright:   (c) 2009 Vadim Zeitlin <vadim@wxwidgets.org>
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
 
 @page overview_debugging Debugging
 
-Classes, functions and macros: wxLog, @ref group_funcmacro_log, @ref group_funcmacro_debug
+@tableofcontents
 
-Various classes, functions and macros are provided in wxWidgets to help you debug
-your application: @ref overview_debugging_dbgmacros allow you to insert various
-checks in your application which can be compiled out or disabled in release
-builds but are extremely useful while developing and @ref
-overview_debugging_logging which are not limited to debugging but are also
-useful for inserting traces into your application code. Both assertions and
-debug logging are also used by wxWidgets itself so you may encounter them even
-if you don't use either of these features yourself.
+Various classes, functions and macros are provided in wxWidgets to help you
+debug your application. Assertion macros allow you to insert various checks in
+your application which can be compiled out or disabled in release builds but
+are extremely useful while developing. Logging functions are also provided
+which are useful for inserting traces into your application code as well as
+debugging. Both assertions and debug logging are also used by wxWidgets itself
+so you may encounter them even if you don't use either of these features
+yourself.
+
+@see wxLog, @ref group_funcmacro_log, @ref group_funcmacro_debug 
 
 
-@section overview_debugging_config Configuring debugging support
+
+@section overview_debugging_config Configuring Debug Support
 
 Starting with wxWidgets 2.9.1 debugging features are always available by
 default (and not only in a special "debug" build of the library) and you need
@@ -42,8 +44,8 @@ yourself.
 
 Also notice that it is possible to build your own application with a different
 value of wxDEBUG_LEVEL than the one which was used for wxWidgets itself. E.g.
-you may be using an official binary version of the library which will have
-been compiled with default @code wxDEBUG_LEVEL == 1 @endcode but still predefine
+you may be using an official binary version of the library which will have been
+compiled with default @code wxDEBUG_LEVEL == 1 @endcode but still predefine
 wxDEBUG_LEVEL as 0 for your own code.
 
 On the other hand, if you do want to keep the asserts even in production
@@ -56,7 +58,8 @@ application log file or maybe notify the user about the problem in some more
 user-friendly way.
 
 
-@section overview_debugging_dbgmacros Assertion macros
+
+@section overview_debugging_dbgmacros Assertion Macros
 
 wxASSERT(), wxFAIL(), wxCHECK() as well as their other variants (see @ref
 group_funcmacro_debug) are similar to the standard assert() macro but are more
@@ -101,12 +104,9 @@ message box in the @ref page_samples_except.
 
 
 
-@section overview_debugging_logging Logging functions
-
-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_logging Logging Functions
 
+You can use the wxLogDebug and wxLogTrace functions to output debugging
+information in debug mode; it will do nothing for non-debugging code.
 
 */
-