Changeset 298:24c67ec5cdca for src/mlx/logger.py

Timestamp:

07/21/12 12:43:34 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

hg-Phase:

(<MercurialRepository 1 'hg:/home/ivaradi/mlx/hg' '/'>, 'public')

Message:

Documented the non-GUI modules

File:

• src/mlx/logger.py (modified) (2 diffs)

src/mlx/logger.py

@@ -1 @@
-# Module for the logging.
-
-#--------------------------------------------------------------------------------------
 
 from fs import sendMessage
@@ -9 +6 @@
 import sys
 import time
+
+#--------------------------------------------------------------------------------------
+
+## @package mlx.logger
+#
+# The module for the logger.
+#
+# While the program itself is "logger", it contains an internal logger, which
+# maintains the textual log containing information on the various events and is
+# the reason why the program is called "logger".
+#
+# The log is made up of lines containing an optional timestamp and the text of
+# the message. A line can be updated after having been put into the log by
+# referring to its index.
+#
+# The logger object also maintains a separate set of faults and ensures that
+# one fault type has only one score, even if that fault has been reported
+# multiple times.
 
 #--------------------------------------------------------------------------------------