Changeset 297:9d1f71a9de51


Ignore:
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:
3 edited

Legend:

Unmodified
Added
Removed
  • doc/Doxyfile

    r295 r297  
    352352# will be included in the documentation.
    353353
    354 EXTRACT_PRIVATE        = NO
     354EXTRACT_PRIVATE        = YES
    355355
    356356# If the EXTRACT_STATIC tag is set to YES all static members of a file
     
    649649# with spaces.
    650650
    651 INPUT                  =  ../src/mlx
     651INPUT                  =  ../src/mlx ../src/mlx/gui
    652652
    653653# This tag can be used to specify the character encoding of the source files
  • src/mlx/acft.py

    r274 r297  
    1 # Module for the simulator-independent aircraft classes
     1## @package mlx.acft
     2#
     3# The simulator-independent aircraft classes.
     4#
     5# This module contains the aircraft classes that contain some general data
     6# about each aircraft type in the MAVA Fleet. The base class, \ref Aircraft
     7# also implements some parts of the logging and traces some data. The classes
     8# are also responsible for creating the \ref mlx.checks "checkers". Most of
     9# them are created by the \ref Aircraft class' constructor, but there can be
     10# type-specific differences. For example the lights are different for different
     11# types, so there is a \ref Aircraft._appendLightsLoggers "function" which can
     12# be reimplemented in child classes, if needed. This class maintains also the
     13# \ref SmoothedValue "smoothed values" of the IAS and the VS and set these
     14# values in the \ref mlx.fs.AircraftState "aircraft state" when it is received
     15# from the simulator.
    216
    317#---------------------------------------------------------------------------------------
  • src/mlx/checks.py

    r273 r297  
    1 # The various checks that may be performed during flight
     1## @package mlx.checks
     2#
     3# The classes that check the state of the aircraft.
     4#
     5# During the flight the program periodically queries various data from the
     6# simulator. This data is returned in instances of the \ref
     7# mlx.fs.AircraftState class and passed to the various "checkers",
     8# i.e. instances of subclasses of the \ref StateChecker class. These checkers
     9# perform various checks to see if the aircraft's parameters are within the
     10# expected limits, or some of them just logs something.
     11#
     12# There are a few special ones, such as \ref StageChecker which computes the
     13# transitions from one stage of the flight to the next one. Or \ref ACARSSender
     14# which sends the ACARS periodically
    215
    316#---------------------------------------------------------------------------------------
     
    94107    It sends the ACARS every 3 minutes to the MAVA website."""
    95108
    96     # The interval at which ACARS is sent
     109    ## The interval at which the ACARS are sent
    97110    INTERVAL = 3*60.0
    98111   
Note: See TracChangeset for help on using the changeset viewer.