# HG changeset patch
# User alpar
# Date 1087204866 0
# Node ID 17415189e42ab0bda89853575d7766b93accbf63
# Parent  5860141a60b54b4e3da39936c6e4ddef6c1a7736
Improved (but still not satisfactory) doc.

diff -r 5860141a60b5 -r 17415189e42a src/work/klao/debug.h
--- a/src/work/klao/debug.h	Mon Jun 14 08:49:07 2004 +0000
+++ b/src/work/klao/debug.h	Mon Jun 14 09:21:06 2004 +0000
@@ -8,6 +8,10 @@
 
 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
     static const bool consistensy_check = true;
@@ -22,6 +26,11 @@
     static const int verbose = 5;
   };
 
+  //! 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;
     static const bool range_check = false;
@@ -30,8 +39,16 @@
   };
 
 #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