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

src/mlx/gui/update.py

@@ -1 @@
-# The GUI part of the update
-
-#-------------------------------------------------------------------------------
 
 from mlx.gui.common import *
@@ -13 +10 @@
 import os
 import sys
+
+#-------------------------------------------------------------------------------
+
+## @package mlx.gui.update
+#
+# The GUI part of the update.
+#
+# This module implements the GUI portion of the \ref mlx.update
+# "automatic update" function. The update runs in a separate thread, which puts
+# the relevant events into the Gtk event loop.
 
 #-------------------------------------------------------------------------------