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

Timestamp:

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

Author:

István Váradi <ivaradi@…>

Branch:

default

Phase:

public

Message:

Documented the non-GUI modules

File:

• src/mlx/web.py (modified) (2 diffs)

src/mlx/web.py

@@ -1 @@
-# Interface towards the websites used
-
-#------------------------------------------------------------------------------
 
 import const
@@ -16 +13 @@
 import traceback
 import xml.sax
+
+#---------------------------------------------------------------------------------------
+
+## @package mlx.web
+#
+# Web interface.
+#
+# This module implements a thread that can perform (HTTP) requests
+# asynchronously. When the request is performed, a callback is called. The main
+# interface is the \ref Handler class. Each of its functions creates a \ref
+# Request subclass instance and puts it to the request queue. The handler
+# thread then takes the requests one by one, and executes them.
+#
+# This module also defines some data classes the contents of which are
+# retrieved or sent via HTTP. \ref BookedFlight contains data of a flight
+# booked on the MAVA website, \ref Fleet and \ref Plane represents the MAVA
+# fleet and the gates at Ferihegy and \ref NOTAM is a NOTAM.
 
 #---------------------------------------------------------------------------------------