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

Timestamp:

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

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Added the module comments for the GUI

File:

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

src/mlx/gui/gui.py

@@ -1 @@
-# The main file for the GUI
 # -*- coding: utf-8 -*-
 
@@ -32 +31 @@
 import datetime
 import webbrowser
+
+#------------------------------------------------------------------------------
+
+## @package mlx.gui.gui
+#
+# The main GUI class.
+#
+# The \ref GUI class is the main class of the GUI. It is a connection listener,
+# and aggregates all the windows, the menu, etc. It maintains the connection to
+# the simulator as well as the flight object.
 
 #------------------------------------------------------------------------------