Changeset 298:24c67ec5cdca for src/mlx/pyuipc_emu.py

Timestamp:

07/21/12 12:43:34 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

hg-Phase:

(<MercurialRepository 1 'hg:/home/ivaradi/mlx/hg' '/'>, 'public')

Message:

Documented the non-GUI modules

File:

• src/mlx/pyuipc_emu.py (modified) (5 diffs)

src/mlx/pyuipc_emu.py

@@ -1 @@
-# Emulator for the pyuipc module
-#------------------------------------------------------------------------------
 
 import time
@@ -6 +4 @@
 #------------------------------------------------------------------------------
 
-# The ratio between kg and lbs
+## @package mlx.pyuipc_emu
+#
+# A very simple PyUIPC emulator.
+#
+# This is not used currently.
+
+#------------------------------------------------------------------------------
+
+## The ratio between kg and lbs
 KGTOLBS=1/0.4536
 
-# Feet to metres
+## Feet to metres
 FEETTOMETRES=0.3048
 
@@ -36 +42 @@
 #------------------------------------------------------------------------------
 
-# Version constants
+## Version constants
 SIM_ANY=0
 SIM_FS98=1
@@ -48 +54 @@
 #------------------------------------------------------------------------------
 
-# Error constants
+## Error constants
 ERR_OK=0
 ERR_OPEN=1
@@ -68 +74 @@
 #------------------------------------------------------------------------------
 
-# The version of FSUIPC
+## The version of FSUIPC
 fsuipc_version=0x0401
 lib_version=0x0302