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

src/mlx/gui/common.py

@@ -1 @@
-# Common things for the GUI
 
 import mlx.const as _const
@@ -5 +4 @@
 
 import os
+
+#-----------------------------------------------------------------------------
+
+## @package mlx.gui.common
+#
+# Common definitions and utilities for the GUI
+#
+# The main purpose of this module is to provide common definitions for things
+# that are named differently in Gtk+ 2 and 3. This way the other parts of the
+# GUI have to check the version in use very rarely. The variable \ref pygobject
+# tells which version is being used. If it is \c True, Gtk+ 3 is used via the
+# PyGObject interface. Otherwise Gtk+ 2 is used, which is the default on
+# Windows or when the \c FORCE_PYGTK environment variable is set.
+#
+# Besides this there some common utility classes and functions.
+
+#-----------------------------------------------------------------------------
 
 appIndicator = False