X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/526954c5968baa29218c994ec48e476ae2bd4b9f..4e15d1caa03346c126015019c1fdf093033ef40b:/docs/doxygen/overviews/debugging.h

diff --git a/docs/doxygen/overviews/debugging.h b/docs/doxygen/overviews/debugging.h
index d339b198a7..880e2e4e20 100644
--- a/docs/doxygen/overviews/debugging.h
+++ b/docs/doxygen/overviews/debugging.h
@@ -11,19 +11,22 @@
 
 @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. 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 
 
-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.
 
 
-@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 +45,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 +59,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 +105,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.
 
 */
-