Improved (but still not satisfactory) doc.
authoralpar
Mon, 14 Jun 2004 09:21:06 +0000
changeset 68017415189e42a
parent 679 5860141a60b5
child 681 06a3cba90f94
Improved (but still not satisfactory) doc.
src/work/klao/debug.h
     1.1 --- a/src/work/klao/debug.h	Mon Jun 14 08:49:07 2004 +0000
     1.2 +++ b/src/work/klao/debug.h	Mon Jun 14 09:21:06 2004 +0000
     1.3 @@ -8,6 +8,10 @@
     1.4  
     1.5  namespace hugo {
     1.6  
     1.7 +  //! Debug mode for testing/debugging
     1.8 +
     1.9 +  //! Use this debug mode if you want exhaustive range and consistency checks.
    1.10 +  //! It also produces verbose debug messages.
    1.11    struct DebugOn {
    1.12      //! Example: check whether the edges added to a path are adjacent
    1.13      static const bool consistensy_check = true;
    1.14 @@ -22,6 +26,11 @@
    1.15      static const int verbose = 5;
    1.16    };
    1.17  
    1.18 +  //! Debug mode for turning off debug aids.
    1.19 +
    1.20 +  //! This debud mode switches off all range and consistency checks,
    1.21 +  //! as well as the debug messages.
    1.22 +  //!
    1.23    struct DebugOff {
    1.24      static const bool consistensy_check = false;
    1.25      static const bool range_check = false;
    1.26 @@ -30,8 +39,16 @@
    1.27    };
    1.28  
    1.29  #ifdef DEBUG
    1.30 +  //! The default debug mode.
    1.31 +
    1.32 +  //! The default debug mode.
    1.33 +  //!
    1.34    typedef DebugOn DefaultDebugMode;
    1.35  #else
    1.36 +  //! The default debug mode. 
    1.37 +
    1.38 +  //! The default debug mode. 
    1.39 +  //!
    1.40    typedef DebugOff DefaultDebugMode;
    1.41  #endif
    1.42