Changeset 300:f101bd18f39d for src/mlx/gui/pirep.py

Timestamp:

07/22/12 17:28:25 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

hg-Phase:

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

Message:

Added the module comments for the GUI

File:

• src/mlx/gui/pirep.py (modified) (2 diffs)

src/mlx/gui/pirep.py

@@ -1 @@
-# Module for the detailed PIREP viewer
-
-#------------------------------------------------------------------------------
 
 from common import *
@@ -9 +6 @@
 
 import time
+
+#------------------------------------------------------------------------------
+
+## @package mlx.gui.pirep
+#
+# The detailed PIREP viewer.
+#
+# The \ref PIREPViewer class is a dialog displaying all information found in a
+# PIREP. It consists of three tabs. The Data tab displays the simple,
+# itemizable data. The Comments & defects tab contains the flight comments and
+# defects, while the Log tab contains the flight log collected by the
+# \ref mlx.logger.Logger "logger".
 
 #------------------------------------------------------------------------------