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

src/mlx/gui/checklist.py

@@ -1 @@
-# Module for editing checklists
-
-#------------------------------------------------------------------------------
 
 from common import *
@@ -10 +7 @@
 
 import os
+
+#------------------------------------------------------------------------------
+
+## @package mlx.gui.checklist
+#
+# The checklist editor dialog.
+#
+# This module implements the checklist editor dialog. A checklist is a list of
+# sound files that are played one-by-one when requested by the user. The top
+# part of the dialog contains an aircraft type selector. Below it, on the left
+# there is a file selector, and the list of the files in the checklist to the
+# right. There are some buttons in the middle to manipulate the checklist.
 
 #------------------------------------------------------------------------------