ソースを参照

debug.py: doxygenization

git-svn-id: https://svn.osgeo.org/grass/grass/trunk@40143 15284696-431f-4ddb-bdfa-cd5b030d7da7
Martin Landa 15 年 前
コミット
47d383dcb3
1 ファイル変更21 行追加18 行削除
  1. 21 18
      gui/wxpython/gui_modules/debug.py

+ 21 - 18
gui/wxpython/gui_modules/debug.py

@@ -1,21 +1,21 @@
-"""
-MODULE: debug
+"""!
+@package debug
 
-CLASSES:
- * DebugMsg
+@brief Debugging
 
-PURPOSE: GRASS debugging
+Classes:
+ - DebugMsg
 
-         from debug import Debug as Debug
-         Debug.msg (3, 'debug message')
+@code
+from debug import Debug as Debug
+Debug.msg (3, 'debug message')
+@endcode
          
-AUTHORS: The GRASS Development Team
-         Martin Landa <landa.martin gmail.com>
+COPYRIGHT: (C) 2007-2009 by the GRASS Development Team
+This program is free software under the GNU General Public License
+(>=v2). Read the file COPYING that comes with GRASS for details.
 
-COPYRIGHT: (C) 2007-2008 by the GRASS Development Team
-           This program is free software under the GNU General Public
-           License (>=v2). Read the file COPYING that comes with GRASS
-           for details.
+@author Martin Landa <landa.martin gmail.com>
 """
 
 import os
@@ -24,10 +24,12 @@ import sys
 import globalvar
 
 class DebugMsg:
-    """
-    GRASS Debugging
+    """!
+    wxGUI debugging
 
+    @code
     export GRASS_WX_DEBUG=[0-5]
+    @endcode
     """
     def __init__(self):
         # default level
@@ -46,16 +48,16 @@ class DebugMsg:
                 
             if self.debuglevel != level:
                 self.debuglevel = level
-
+        
     def msg (self, level, message):
         self._update_level()
         if self.debuglevel > 0 and level > 0 and level <= self.debuglevel:
             print >> sys.stderr, "GUI D%d/%d: %s" % (level, self.debuglevel, message)
-
+        
     def get_level(self):
         """!Return current GUI debug level"""
         return self.debuglevel
-
+    
 # Debug instance
 Debug = DebugMsg()
 
@@ -67,3 +69,4 @@ if __name__ == "__main__":
                 
     for level in range (4):
         Debug.msg (level, "message level=%d" % level)
+