Changeset 298:24c67ec5cdca for src/mlx/config.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/config.py (modified) (2 diffs)

src/mlx/config.py

@@ -1 @@
-# Configuration and related stuff
 # -*- encoding: utf-8 -*-
-
-#-------------------------------------------------------------------------------
 
 import const
@@ -9 +6 @@
 import sys
 import ConfigParser
+
+## @package mlx.config
+# 
+# The handling of the configuration.
+#
+# The \ref Config class contains the main configuration and is capable of
+# loading and saving the configuration. It contains getters and setters for the
+# configuration options.
+#
+# Some parts of the configuration are not simple data items, like strings or
+# booleans, but more complicated data. These have their own class, like \ref
+# ApproachCallouts or \ref Checklist.
 
 #-------------------------------------------------------------------------------