Changeset 295:7340a9356485 for src/mlx/fs.py

Timestamp:

07/21/12 10:24:48 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Documented the fs module and changed some settings

File:

• src/mlx/fs.py (modified) (1 diff)

src/mlx/fs.py

@@ -1 @@
-# Module for generic flight-simulator interfaces
+## @package mlx.fs
+#
+# The main interface to the flight simulator.
+#
+# The \ref createSimulator function can be used to create an instance of
+# the class that can be used to access the simulator. It expects an instance of
+# the \ref ConnectionListener class, the member functions of which will be
+# called when something happens with the connection to the simulator.
+#
+# The simulator interface is most often used to retrieve the state of the
+# simulated aircraft. Instances of class \ref AircraftState are used for this
+# purpose.
 
 #-------------------------------------------------------------------------------