Changeset 680:17415189e42a in lemon-0.x

Timestamp:

06/14/04 11:21:06 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@928

Message:

Improved (but still not satisfactory) doc.

File:

• src/work/klao/debug.h (modified) (3 diffs)

src/work/klao/debug.h

@@ -9 +9 @@
 namespace hugo {
 
+  //! Debug mode for testing/debugging
+
+  //! Use this debug mode if you want exhaustive range and consistency checks.
+  //! It also produces verbose debug messages.
   struct DebugOn {
     //! Example: check whether the edges added to a path are adjacent
@@ -23 +27 @@
   };
 
+  //! Debug mode for turning off debug aids.
+
+  //! This debud mode switches off all range and consistency checks,
+  //! as well as the debug messages.
+  //!
   struct DebugOff {
     static const bool consistensy_check = false;
@@ -31 +40 @@
 
 #ifdef DEBUG
+  //! The default debug mode.
+
+  //! The default debug mode.
+  //!
   typedef DebugOn DefaultDebugMode;
 #else
+  //! The default debug mode. 
+
+  //! The default debug mode. 
+  //!
   typedef DebugOff DefaultDebugMode;
 #endif