Changeset 300:f101bd18f39d for src/mlx/gui/callouts.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/callouts.py (modified) (2 diffs)

src/mlx/gui/callouts.py

@@ -1 @@
-# Module for editing checklists
-
-#------------------------------------------------------------------------------
 
 from common import *
@@ -11 +8 @@
 import os
 import re
+
+#------------------------------------------------------------------------------
+
+## @package mlx.gui.callouts
+#
+# Editor dialog for approach callouts.
+#
+# The dialog consists of an aircraft type selector box at the top, and a table
+# with two buttons below it. The table contains the callout files with the
+# corresponding altitudes, and is sorted according to the altitude. When a new
+# file is added, the program finds out a new altitude for it. If the file's
+# name contains numbers that are not used as altitudes yet, the most suitable
+# of those numbers will be used. Otherwise a 'usual' altitude is searched for,
+# in the direction according to the sort order, and if that fails too, the
+# altitudes are tried one-by-one. See the
+# \ref ApproachCalloutsEditor._getNewAltitude function for more details.
 
 #------------------------------------------------------------------------------