Changeset 298:24c67ec5cdca for src/mlx/pirep.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/pirep.py (modified) (1 diff)

src/mlx/pirep.py

@@ -1 @@
-# The PIREP class collecting all information needed for a PIREP
+
+import const
+import cPickle as pickle
 
 #------------------------------------------------------------------------------
 
-import const
-import cPickle as pickle
+## @package mlx.pirep
+#
+# The PIREP module.
+#
+# This module defines only one class, \ref PIREP. It is used to extract and
+# store the information needed for a PIREP. The saved PIREPs are pickled
+# instances of this class.
 
 #------------------------------------------------------------------------------