Changeset 295:7340a9356485

Timestamp:

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

Author:

István Váradi <ivaradi@…>

Branch:

default

hg-Phase:

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

Message:

Documented the fs module and changed some settings

Files:

• doc/Doxyfile (modified) (2 diffs)
• src/mlx/fs.py (modified) (1 diff)

doc/Doxyfile

@@ -120 +120 @@
 # to NO the shortest path that makes the file name unique will be used.
 
-FULL_PATH_NAMES        = YES
+FULL_PATH_NAMES        = NO
 
 # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
@@ -776 +776 @@
 # VERBATIM_HEADERS is set to NO.
 
-SOURCE_BROWSER         = NO
+SOURCE_BROWSER         = YES
 
 # Setting the INLINE_SOURCES tag to YES will include the body

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.
 
 #-------------------------------------------------------------------------------