Changeset 297:9d1f71a9de51

Timestamp:

07/21/12 10:50:57 (12 years ago)

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Added some further documentation

Files:

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

doc/Doxyfile

@@ -352 +352 @@
 # will be included in the documentation.
 
-EXTRACT_PRIVATE        = NO
+EXTRACT_PRIVATE        = YES
 
 # If the EXTRACT_STATIC tag is set to YES all static members of a file
@@ -649 +649 @@
 # with spaces.
 
-INPUT                  =  ../src/mlx
+INPUT                  =  ../src/mlx ../src/mlx/gui
 
 # This tag can be used to specify the character encoding of the source files

src/mlx/acft.py

@@ -1 @@
-# Module for the simulator-independent aircraft classes
+## @package mlx.acft
+#
+# The simulator-independent aircraft classes.
+#
+# This module contains the aircraft classes that contain some general data
+# about each aircraft type in the MAVA Fleet. The base class, \ref Aircraft
+# also implements some parts of the logging and traces some data. The classes
+# are also responsible for creating the \ref mlx.checks "checkers". Most of
+# them are created by the \ref Aircraft class' constructor, but there can be
+# type-specific differences. For example the lights are different for different
+# types, so there is a \ref Aircraft._appendLightsLoggers "function" which can
+# be reimplemented in child classes, if needed. This class maintains also the
+# \ref SmoothedValue "smoothed values" of the IAS and the VS and set these
+# values in the \ref mlx.fs.AircraftState "aircraft state" when it is received
+# from the simulator.
 
 #---------------------------------------------------------------------------------------

src/mlx/checks.py

@@ -1 @@
-# The various checks that may be performed during flight
+## @package mlx.checks
+#
+# The classes that check the state of the aircraft.
+#
+# During the flight the program periodically queries various data from the
+# simulator. This data is returned in instances of the \ref
+# mlx.fs.AircraftState class and passed to the various "checkers",
+# i.e. instances of subclasses of the \ref StateChecker class. These checkers
+# perform various checks to see if the aircraft's parameters are within the
+# expected limits, or some of them just logs something.
+#
+# There are a few special ones, such as \ref StageChecker which computes the
+# transitions from one stage of the flight to the next one. Or \ref ACARSSender
+# which sends the ACARS periodically
 
 #---------------------------------------------------------------------------------------
@@ -94 +107 @@
     It sends the ACARS every 3 minutes to the MAVA website."""
 
-    # The interval at which ACARS is sent
+    ## The interval at which the ACARS are sent
     INTERVAL = 3*60.0