Browse code

train ride doxygen documentation

git-svn-id: http://svn.berlios.de/svnroot/repos/sems/trunk@457 8eb893ce-cfd4-0310-b710-fb5ebe64c474

Stefan Sayer authored on 24/09/2007 17:37:04
Showing 93 changed files
... ...
@@ -106,6 +106,10 @@ bundle: ser-0.9.6-sems tar
106 106
 doc:
107 107
 	make -C core/ doc
108 108
 
109
+.PHONY: fulldoc
110
+fulldoc:
111
+	make -C core/ fulldoc
112
+
109 113
 .PHONY: install-ser-cfg
110 114
 install-ser-cfg:
111 115
 	make -C core/ install-ser-cfg
... ...
@@ -37,6 +37,7 @@
37 37
 #include <string>
38 38
 using std::string;
39 39
 
40
+/** \brief Factory for AnnounceB2B sessions */
40 41
 class AnnounceB2BFactory: public AmSessionFactory
41 42
 {
42 43
 public:
... ...
@@ -49,6 +50,7 @@ public:
49 50
   AmSession* onInvite(const AmSipRequest& req);
50 51
 };
51 52
 
53
+/** \brief Session logic implementation of A leg in announce_b2b sessions */
52 54
 class AnnounceCallerDialog: public AmB2BCallerSession
53 55
 {
54 56
   AmAudioFile wav_file;
... ...
@@ -35,6 +35,7 @@
35 35
 #include <string>
36 36
 using std::string;
37 37
 
38
+/** \brief session factory for announce_transfer sessions */
38 39
 class AnnounceTransferFactory: public AmSessionFactory
39 40
 {
40 41
 public:
... ...
@@ -47,6 +48,7 @@ public:
47 48
   AmSession* onInvite(const AmSipRequest& req);
48 49
 };
49 50
 
51
+/** \brief session logic implementation for announce_transfer sessions */
50 52
 class AnnounceTransferDialog : public AmSession
51 53
 {
52 54
   string callee_uri;
... ...
@@ -38,6 +38,7 @@ using std::string;
38 38
 
39 39
 #include <memory>
40 40
 
41
+/** \brief Factory for announcement sessions */
41 42
 class AnnouncementFactory: public AmSessionFactory
42 43
 {
43 44
   inline string getAnnounceFile(const AmSipRequest& req);
... ...
@@ -54,6 +55,7 @@ public:
54 55
 
55 56
 };
56 57
 
58
+/**\brief  announcement session logic implementation */
57 59
 class AnnouncementDialog : public AmSession,
58 60
 			   public CredentialHolder
59 61
 {
... ...
@@ -3,6 +3,7 @@
3 3
 
4 4
 #include "AmAudio.h"
5 5
 
6
+/** \brief audio device that generates ring tones with uesr specified period, f and f2 */
6 7
 class AmRingTone: public AmAudio
7 8
 {
8 9
   int on_period; // ms
... ...
@@ -59,6 +59,7 @@ enum { DoConfConnect = 100,
59 59
        DoConfError
60 60
 };
61 61
 
62
+/** \brief Event to trigger connecting/disconnecting between dialout session and main conference session */
62 63
 struct DialoutConfEvent : public AmEvent {
63 64
 
64 65
   string conf_id;
... ...
@@ -70,6 +71,7 @@ struct DialoutConfEvent : public AmEvent {
70 71
   {}
71 72
 };
72 73
 
74
+/** \brief Factory for conference sessions */
73 75
 class ConferenceFactory : public AmSessionFactory
74 76
 {
75 77
 public:
... ...
@@ -90,6 +92,7 @@ public:
90 92
   virtual int onLoad();
91 93
 };
92 94
 
95
+/** \brief session logic implementation of conference sessions */
93 96
 class ConferenceDialog : public AmSession
94 97
 {
95 98
   AmPlaylist  play_list;
... ...
@@ -34,6 +34,7 @@
34 34
 #include <string>
35 35
 using std::string;
36 36
 
37
+/** \brief Factory for early_announce sessions */
37 38
 class EarlyAnnounceFactory: public AmSessionFactory
38 39
 {
39 40
 public:
... ...
@@ -46,6 +47,7 @@ public:
46 47
   AmSession* onInvite(const AmSipRequest& req);
47 48
 };
48 49
 
50
+/** \brief session logic implementation for early_announce sessions */
49 51
 class EarlyAnnounceDialog : public AmSession
50 52
 {
51 53
   AmAudioFile wav_file;
... ...
@@ -40,6 +40,7 @@ using std::map;
40 40
 
41 41
 class IvrDialog;
42 42
 
43
+/** \brief C++ wrapper for extra thread created by Python IVR script */
43 44
 class PythonScriptThread : public AmThread {
44 45
   PyObject* py_thread_object;
45 46
  protected:
... ...
@@ -50,7 +51,7 @@ class PythonScriptThread : public AmThread {
50 51
    : py_thread_object(py_thread_object_) { }
51 52
 };
52 53
 
53
-
54
+/** \brief binds a script module and the python dialog class */
54 55
 struct IvrScriptDesc
55 56
 {
56 57
   PyObject* mod;
... ...
@@ -73,7 +74,7 @@ IvrScriptDesc(PyObject* mod,
73 74
   {}
74 75
 };
75 76
 
76
-
77
+/** \brief session factory for python IVR sessions */
77 78
 class IvrFactory: public AmSessionFactory
78 79
 {
79 80
   PyObject* ivr_module;
... ...
@@ -112,7 +113,7 @@ class IvrFactory: public AmSessionFactory
112 113
   void addDeferredThread(PyObject* pyCallable);
113 114
 };
114 115
 
115
-
116
+/** \brief python IVR wrapper for session base implementation */
116 117
 class IvrDialog : public AmB2BCallerSession
117 118
 {
118 119
   PyObject  *py_mod;
... ...
@@ -14,7 +14,7 @@
14 14
 #include "flite.h"
15 15
 #endif
16 16
 
17
-// Data definition
17
+/** \brief IVR wrapper of AmAudioFile */
18 18
 typedef struct {
19 19
     
20 20
   PyObject_HEAD
... ...
@@ -7,7 +7,7 @@
7 7
 
8 8
 #include "AmAudioMixIn.h"
9 9
 
10
-// Data definition
10
+/** \brief python IVR wrapper for AmAudioMixIn */ 
11 11
 typedef struct {
12 12
     
13 13
   PyObject_HEAD
... ...
@@ -1,15 +1,14 @@
1 1
 #include "IvrDialogBase.h"
2 2
 #include "IvrAudio.h"
3 3
 #include "IvrAudioMixIn.h"
4
-#
4
+
5 5
 #include "Ivr.h"
6 6
 
7 7
 #include "IvrSipDialog.h"
8 8
 #include "AmMediaProcessor.h"
9 9
 
10
-//#include "AmSessionTimer.h"
11 10
 
12
-// Data definition
11
+/** \brief python wrapper of IvrDialog, the base class for python IVR sessions */
13 12
 typedef struct {
14 13
     
15 14
   PyObject_HEAD
... ...
@@ -3,7 +3,7 @@
3 3
 #include "AmSipDialog.h"
4 4
 #include "log.h"
5 5
 
6
-// Data definition
6
+/** \brief IVR wrapper class of AmSipDialog */
7 7
 typedef struct {
8 8
     
9 9
   PyObject_HEAD
... ...
@@ -24,7 +24,7 @@
24 24
 
25 25
 #include "log.h"
26 26
 
27
-// Data definition
27
+/** \brief IVR wrapper of AmSipReply */
28 28
 typedef struct {
29 29
     
30 30
   PyObject_HEAD
... ...
@@ -25,6 +25,7 @@
25 25
 #include "log.h"
26 26
 
27 27
 // Data definition
28
+/** \brief IVR wrapper of AmSipRequest */
28 29
 typedef struct {
29 30
     
30 31
   PyObject_HEAD
... ...
@@ -27,7 +27,7 @@
27 27
 #include <Python.h>
28 28
 #include "structmember.h"
29 29
 
30
-// Data definition
30
+/** \brief python IVR wrapper for AmUAC functions */
31 31
 typedef struct {
32 32
     
33 33
   PyObject_HEAD
... ...
@@ -55,6 +55,12 @@ EXPORT_SESSION_FACTORY(PySemsFactory,MOD_NAME);
55 55
 
56 56
 PyMODINIT_FUNC initpy_sems_lib();
57 57
 
58
+/** 
59
+ * \brief gets python global interpreter lock (GIL)
60
+ * 
61
+ * structure to acquire the python global interpreter lock (GIL) 
62
+ * while the structure is allocated.
63
+ */
58 64
 struct PythonGIL
59 65
 {
60 66
   PyGILState_STATE gst;
... ...
@@ -76,6 +76,7 @@ PySemsScriptDesc(PyObject* mod,
76 76
 };
77 77
 
78 78
 
79
+/** \brief Factory for PySems sessions */
79 80
 class PySemsFactory: public AmSessionFactory
80 81
 {
81 82
   PyObject* py_sems_module;
... ...
@@ -110,6 +111,7 @@ class PySemsFactory: public AmSessionFactory
110 111
   AmSession* onInvite(const AmSipRequest& req);
111 112
 };
112 113
 
114
+/** \brief wrapper for pySems dialog bas class */
113 115
 class PySemsDialogBase {
114 116
   PyObject  *py_mod;
115 117
   PyObject  *py_dlg;
... ...
@@ -14,7 +14,7 @@
14 14
 #include "flite.h"
15 15
 #endif
16 16
 
17
-// Data definition
17
+/** \brief pySems wrapper for AmAudioFile  */
18 18
 typedef struct {
19 19
     
20 20
   PyObject_HEAD
... ...
@@ -29,6 +29,7 @@
29 29
 
30 30
 class PySemsB2ABCalleeDialog;
31 31
 
32
+/** \brief pySems wrapper for base of pySems dialog classes */
32 33
 class PySemsB2ABDialog : public AmB2ABCallerSession, 
33 34
   public PySemsDialogBase
34 35
 {
... ...
@@ -57,6 +58,7 @@ struct PySemsB2ABEvent: public B2ABEvent
57 58
   {}
58 59
 };
59 60
 
61
+/** \brief pySems wrapper for B leg in pysems B2AB session */
60 62
 class PySemsB2ABCalleeDialog : public AmB2ABCalleeSession
61 63
 {
62 64
  public:
... ...
@@ -28,6 +28,7 @@
28 28
 #include "AmB2BSession.h"
29 29
 #include "AmPlaylist.h"
30 30
 
31
+/** \brief IVR wrapper of AmB2BSession */
31 32
 class PySemsB2BDialog : public AmB2BCallerSession, 
32 33
   public PySemsDialogBase
33 34
 {
... ...
@@ -30,6 +30,7 @@
30 30
 #include "AmPlaylist.h"
31 31
 #include "PySems.h"
32 32
 
33
+/** \brief implementation of session logic/script execution in pySems */
33 34
 class PySemsDialog  :  public AmSession, 
34 35
   public PySemsDialogBase
35 36
 {
... ...
@@ -43,6 +43,7 @@ using std::string;
43 43
 
44 44
 class AmMail;
45 45
 
46
+/** \brief Factory for voicemail sessions */
46 47
 class AnswerMachineFactory: public AmSessionFactory
47 48
 {
48 49
   map<string, EmailTemplate> email_tmpl;
... ...
@@ -72,6 +73,7 @@ public:
72 73
   AmSession* onInvite(const AmSipRequest& req);
73 74
 };
74 75
 
76
+/** \brief implementation of voicemail session logic */
75 77
 class AnswerMachineDialog : public AmSession
76 78
 {
77 79
   AmAudioFile a_greeting,a_beep;
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmAdvancedAudio.h */
27 28
 
28 29
 #ifndef _AmAdvancedAudio_h_
29 30
 #define _AmAdvancedAudio_h_
... ...
@@ -87,6 +88,8 @@ class AmAudioQueue : public AmAudio {
87 88
 };
88 89
 
89 90
 /**
91
+ * \brief AmAudio device with a playlist and a background AmAudio
92
+ *
90 93
  * AmAudioFrontlist is an AmAudio device, that has a playlist
91 94
  * in front of a AmAudio entry, the 'back' device. The back device
92 95
  * is only used if the playlist is empty. - This can be useful when 
... ...
@@ -25,6 +25,7 @@
25 25
  * along with this program; if not, write to the Free Software 
26 26
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27 27
  */
28
+/** @file AmApi.h */
28 29
 #ifndef _AmApi_h_
29 30
 #define _AmApi_h_
30 31
 
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmArg.h */
27 28
 
28 29
 #ifndef _AmArg_h_
29 30
 #define _AmArg_h_
... ...
@@ -34,7 +35,10 @@
34 35
 #include <vector>
35 36
 using std::vector;
36 37
 
37
-/** base for Objects as @see AmArg parameter, not owned by AmArg (!) */
38
+/** \brief base for Objects as @see AmArg parameter
39
+ * 
40
+ * not owned by AmArg (!) 
41
+ */
38 42
 class ArgObject {
39 43
  public:
40 44
   ArgObject() { }
... ...
@@ -57,10 +61,12 @@ class AmArg
57 61
     Array
58 62
   };
59 63
 
64
+  /** \brief exception thrown on access beyond array limits */
60 65
   struct OutOfBoundsException {
61 66
     OutOfBoundsException() { }
62 67
   };
63 68
 
69
+  /** \brief exception thrown if the on argument type mismatch */
64 70
   struct TypeMismatchException {
65 71
     TypeMismatchException() { }
66 72
   };
... ...
@@ -39,6 +39,7 @@
39 39
 
40 40
 #include <typeinfo>
41 41
 
42
+/** \brief structure to hold loaded codec instances */
42 43
 struct CodecContainer
43 44
 {
44 45
   amci_codec_t *codec;
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmAudio.h */
28 28
 #ifndef _AmAudio_h_
29 29
 #define _AmAudio_h_
30 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmAudioMixIn.h */
28 28
 #ifndef _AM_AUDIO_MIX_IN_H
29 29
 #define _AM_AUDIO_MIX_IN_H
30 30
 
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmB2ABSession.h */
27 28
 #ifndef B2ABSession_H
28 29
 #define B2ABSession_H
29 30
 
... ...
@@ -53,6 +54,7 @@ struct B2ABEvent: public AmEvent
53 54
   {}
54 55
 };
55 56
 
57
+/** \brief event fired if B leg is ringing in b2ab session */
56 58
 struct B2ABOtherLegRingingEvent: public B2ABEvent
57 59
 {
58 60
   B2ABOtherLegRingingEvent()
... ...
@@ -95,6 +97,7 @@ struct B2ABConnectLegEvent: public B2ABEvent
95 97
   {}
96 98
 };
97 99
 
100
+/** \brief event fired if an exception occured while creating B leg */
98 101
 struct B2ABConnectOtherLegExceptionEvent: public B2ABEvent {
99 102
 	
100 103
   unsigned int code;
... ...
@@ -107,6 +110,7 @@ struct B2ABConnectOtherLegExceptionEvent: public B2ABEvent {
107 110
   {}
108 111
 };
109 112
 
113
+/** \brief event fired if the B leg could not be connected (e.g. busy) */
110 114
 struct B2ABConnectOtherLegFailedEvent: public B2ABEvent {
111 115
 	
112 116
   unsigned int code;
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmB2BSession.h */
28 28
 #ifndef AmB2BSession_h
29 29
 #define AmB2BSession_h
30 30
 
... ...
@@ -52,7 +52,7 @@ AmFileCache::~AmFileCache() {
52 52
   }
53 53
 }
54 54
 
55
-int AmFileCache::load(const string& filename) {
55
+int AmFileCache::load(const std::string& filename) {
56 56
   int fd; 
57 57
   struct stat sbuf;
58 58
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmCachedAudioFile.h */
28 28
 #ifndef _AMFILECACHE_H
29 29
 #define _AMFILECACHE_H
30 30
 
... ...
@@ -33,6 +33,8 @@
33 33
 #include <string>
34 34
 
35 35
 /**
36
+ * \brief memory cache for AmAudioFile 
37
+ * 
36 38
  * The AmFileCache class loads a file once into memory 
37 39
  * to be used e.g. by AmCachedAudioFile.
38 40
  */
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmCallWatcher.h */
28 28
 #ifndef _AM_CALL_WATCHER_H
29 29
 #define _AM_CALL_WATCHER_H
30 30
 
... ...
@@ -54,7 +54,7 @@ using std::pair;
54 54
 class CallStatus;
55 55
 
56 56
 /** 
57
- * event that carries out call status update
57
+ * \brief event that carries out call status update
58 58
  */
59 59
 class CallStatusUpdateEvent : public AmEvent {
60 60
   string call_id;
... ...
@@ -82,7 +82,7 @@ class CallStatusUpdateEvent : public AmEvent {
82 82
 };
83 83
 
84 84
 /** 
85
- * interface for an update-able call status
85
+ * \brief interface for an update-able call status (AmCallWatcher)
86 86
  */
87 87
 class CallStatus
88 88
 {
... ...
@@ -100,6 +100,7 @@ class CallStatus
100 100
 
101 101
 class AmCallWatcherGarbageCollector;
102 102
 /**
103
+ * \brief manages call status to be queried by external processes 
103 104
  * call watcher is an entity for managing call status
104 105
  * via events that change status. Events are executed in a 
105 106
  * separate thread serially by processing the event queue, 
... ...
@@ -142,6 +143,8 @@ class AmCallWatcher
142 143
 };
143 144
 
144 145
 /** 
146
+ * \brief garbage collector for the AmCallWatcher
147
+ * 
145 148
  * checks garbage every two seconds. 
146 149
  * A bit inefficient with two threads, but AmCallWatcher
147 150
  * shouldn't be blocked by event.
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmConferenceChannel.h */
27 28
 #ifndef AmConferenceChannel_h
28 29
 #define AmConferenceChannel_h
29 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmConferenceStatus.h */
28 28
 #ifndef _ConferenceStatus_h_
29 29
 #define _ConferenceStatus_h_
30 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmConfig.h */
28 28
 #ifndef _AmConfig_h_
29 29
 #define _AmConfig_h_
30 30
 
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmConfigReader.h */
27 28
 #ifndef AmConfigReader_h
28 29
 #define AmConfigReader_h
29 30
 
... ...
@@ -1,3 +1,4 @@
1
+/** @file AmCtrlInterface.h */
1 2
 #ifndef AmCtrlInterface_h
2 3
 #define AmCtrlInterface_h
3 4
 
... ...
@@ -383,7 +383,7 @@ static int IVR_dtmf_matrix[4][4] =
383 383
 #define PI              3.1415926
384 384
 #define NELEMSOF(x) (sizeof(x)/sizeof(*x))
385 385
 
386
-
386
+/** \brief DTMF tone filter type */
387 387
 typedef struct {
388 388
   int freq;			/* frequency */
389 389
   int grp;			/* low/high group */
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmDtmfDetector.h */
27 28
 #ifndef _AmDtmfDetector_h_
28 29
 #define _AmDtmfDetector_h_
29 30
 
... ...
@@ -102,7 +103,7 @@ class AmDtmfEvent : public AmEvent
102 103
   int duration() const { return m_duration_msec; }
103 104
 };
104 105
 /**
105
- * this is the Interface for a sink for KeyPresses.
106
+ * \brief Interface for a sink for KeyPresses.
106 107
  */
107 108
 class AmKeyPressSink {
108 109
  public:
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmEvent.h */
27 28
 #ifndef AmEvent_h
28 29
 #define AmEvent_h
29 30
 
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmEventQueue.h */
27 28
 #ifndef _AMEVENTQUEUE_H_
28 29
 #define _AMEVENTQUEUE_H_
29 30
 
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmIcmpWatcher.h */
27 28
 #ifndef _AmIcmpWatcher_h_
28 29
 #define _AmIcmpWatcher_h_
29 30
 
... ...
@@ -25,7 +25,7 @@
25 25
  * along with this program; if not, write to the Free Software 
26 26
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27 27
  */
28
-
28
+/** @file AmInterfaceHandler.h */
29 29
 #ifndef AmInterfaceHandler_h
30 30
 #define AmInterfaceHandler_h
31 31
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmJitterBuffer.h */
28 28
 #ifndef _AmJitterBuffer_h_
29 29
 #define _AmJitterBuffer_h_
30 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmMail.h */
28 28
 #ifndef _AmMail_h_
29 29
 #define _AmMail_h_
30 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmMediaProcessor.h */
28 28
 #ifndef _AmMediaProcessor_h_
29 29
 #define _AmMediaProcessor_h_
30 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmMultiPartyMixer.h */
28 28
 #ifndef _MultiPartyMixer_h_
29 29
 #define _MultiPartyMixer_h_
30 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmPlaylist.h */
28 28
 #ifndef AmPlaylist_h
29 29
 #define AmPlaylist_h
30 30
 
... ...
@@ -99,6 +99,8 @@ public:
99 99
 };
100 100
 
101 101
 /**
102
+ * \brief playlistelement to notify session about the playlist progress
103
+ *
102 104
  * null-playlist element which notifies session that this position in 
103 105
  * playlist is reached. It fies a AmPlaylistSeparatorEvent if it is 
104 106
  * read or written.
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmPlayoutBuffer.h */
28 28
 #ifndef _AmPlayoutBuffer_h_
29 29
 #define _AmPlayoutBuffer_h_
30 30
 
... ...
@@ -25,7 +25,7 @@
25 25
  * along with this program; if not, write to the Free Software 
26 26
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27 27
  */
28
-
28
+/** @file AmPlugIn.h */
29 29
 #ifndef _AmPlugIn_h_
30 30
 #define _AmPlugIn_h_
31 31
 
... ...
@@ -25,11 +25,10 @@
25 25
  * along with this program; if not, write to the Free Software 
26 26
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27 27
  */
28
-
28
+/** @file AmPromptCollection.h */
29 29
 #ifndef AM_PROMPT_COLLECTION_H
30 30
 #define AM_PROMPT_COLLECTION_H
31 31
 
32
-
33 32
 /**
34 33
  *
35 34
  * Example how to use:
... ...
@@ -108,7 +107,7 @@ class AmPromptCollection {
108 107
 };
109 108
 
110 109
 /** 
111
- *  AudioFile with filename 
110
+ *  \brief AmAudioFile with filename and open flag 
112 111
  */
113 112
 
114 113
 class AudioFileEntry : public AmAudioFile {
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmRtpAudio.h */
28 28
 #ifndef _AmRtpAudio_h_
29 29
 #define _AmRtpAudio_h_
30 30
 
... ...
@@ -24,6 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
+/** @file AmRtpPacket.h */
27 28
 #ifndef _AmRtpPacket_h_
28 29
 #define _AmRtpPacket_h_
29 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmRtpReceiver.h */
28 28
 #ifndef _AmRtpReceiver_h_
29 29
 #define _AmRtpReceiver_h_
30 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmRtpStream.h */
28 28
 #ifndef _RtpStream_h_
29 29
 #define _RtpStream_h_
30 30
 
... ...
@@ -243,6 +243,7 @@ public:
243 243
 
244 244
   virtual unsigned int bytes2samples(unsigned int) const = 0;
245 245
 };
246
+
246 247
 /** \brief represents info about an \ref AmRtpStream */
247 248
 struct AmRtpStreamInfo
248 249
 {
... ...
@@ -263,6 +264,7 @@ struct AmRtpStreamInfo
263 264
 		  AmAudio* audio_rec = NULL);
264 265
 };
265 266
 
267
+/** \brief event fired on RTP timeout */
266 268
 class AmRtpTimeoutEvent
267 269
   : public AmEvent
268 270
 {
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmServer.h */
28 28
 #ifndef _AmServer_h_
29 29
 #define _AmServer_h_
30 30
 
... ...
@@ -45,6 +45,7 @@ using std::greater;
45 45
 class AmCtrlInterface;
46 46
 class AmInterfaceHandler;
47 47
 
48
+/** \brief binds a AmCtrlInterface and an AmInterfaceHandler*/
48 49
 struct IfaceDesc
49 50
 {
50 51
   AmCtrlInterface*    ctrl;
... ...
@@ -119,7 +119,6 @@ bool AmSessionEventHandler::onSendReply(const AmSipRequest& req,
119 119
 #endif
120 120
 
121 121
 
122
-
123 122
 AmSession::AmSession()
124 123
   : AmEventQueue(this), // AmDialogState(),
125 124
     dlg(this),
... ...
@@ -51,6 +51,8 @@ using std::pair;
51 51
 class AmSessionFactory;
52 52
 class AmDtmfEvent;
53 53
 
54
+/** @file AmSession.h */
55
+
54 56
 /* definition imported from Ser parser/msg_parser.h */
55 57
 #define FL_FORCE_ACTIVE 2
56 58
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmSessionContainer.h */
28 28
 #ifndef AmSessionContainer_h
29 29
 #define AmSessionContainer_h
30 30
 
... ...
@@ -1,3 +1,30 @@
1
+/*
2
+ * $Id$
3
+ *
4
+ * Copyright (C) 2002-2003 Fhg Fokus
5
+ *
6
+ * This file is part of sems, a free SIP media server.
7
+ *
8
+ * sems is free software; you can redistribute it and/or modify
9
+ * it under the terms of the GNU General Public License as published by
10
+ * the Free Software Foundation; either version 2 of the License, or
11
+ * (at your option) any later version
12
+ *
13
+ * For a license to use the ser software under conditions
14
+ * other than those described here, or to purchase support for this
15
+ * software, please contact iptel.org by e-mail at the following addresses:
16
+ *    info@iptel.org
17
+ *
18
+ * sems is distributed in the hope that it will be useful,
19
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
20
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21
+ * GNU General Public License for more details.
22
+ *
23
+ * You should have received a copy of the GNU General Public License 
24
+ * along with this program; if not, write to the Free Software 
25
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26
+ */
27
+/** @file AmSipDialog.h */
1 28
 #ifndef AmSipDialog_h
2 29
 #define AmSipDialog_h
3 30
 
... ...
@@ -1,3 +1,30 @@
1
+/*
2
+ * $Id$
3
+ *
4
+ * Copyright (C) 2002-2003 Fhg Fokus
5
+ *
6
+ * This file is part of sems, a free SIP media server.
7
+ *
8
+ * sems is free software; you can redistribute it and/or modify
9
+ * it under the terms of the GNU General Public License as published by
10
+ * the Free Software Foundation; either version 2 of the License, or
11
+ * (at your option) any later version
12
+ *
13
+ * For a license to use the ser software under conditions
14
+ * other than those described here, or to purchase support for this
15
+ * software, please contact iptel.org by e-mail at the following addresses:
16
+ *    info@iptel.org
17
+ *
18
+ * sems is distributed in the hope that it will be useful,
19
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
20
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21
+ * GNU General Public License for more details.
22
+ *
23
+ * You should have received a copy of the GNU General Public License 
24
+ * along with this program; if not, write to the Free Software 
25
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26
+ */
27
+/** @file AmSipEvent.h */
1 28
 #ifndef AmSipEvent_h
2 29
 #define AmSipEvent_h
3 30
 
... ...
@@ -1,5 +1,32 @@
1
-#ifndef _AmReply_h_
2
-#define _AmReply_h_
1
+/*
2
+ * $Id$
3
+ *
4
+ * Copyright (C) 2002-2003 Fhg Fokus
5
+ *
6
+ * This file is part of sems, a free SIP media server.
7
+ *
8
+ * sems is free software; you can redistribute it and/or modify
9
+ * it under the terms of the GNU General Public License as published by
10
+ * the Free Software Foundation; either version 2 of the License, or
11
+ * (at your option) any later version
12
+ *
13
+ * For a license to use the ser software under conditions
14
+ * other than those described here, or to purchase support for this
15
+ * software, please contact iptel.org by e-mail at the following addresses:
16
+ *    info@iptel.org
17
+ *
18
+ * sems is distributed in the hope that it will be useful,
19
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
20
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21
+ * GNU General Public License for more details.
22
+ *
23
+ * You should have received a copy of the GNU General Public License 
24
+ * along with this program; if not, write to the Free Software 
25
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26
+ */
27
+/** @file AmSipReply.h */
28
+#ifndef _AmSipReply_h_
29
+#define _AmSipReply_h_
3 30
 
4 31
 #include "AmEventQueue.h"
5 32
 
... ...
@@ -1,3 +1,30 @@
1
+/*
2
+ * $Id$
3
+ *
4
+ * Copyright (C) 2002-2003 Fhg Fokus
5
+ *
6
+ * This file is part of sems, a free SIP media server.
7
+ *
8
+ * sems is free software; you can redistribute it and/or modify
9
+ * it under the terms of the GNU General Public License as published by
10
+ * the Free Software Foundation; either version 2 of the License, or
11
+ * (at your option) any later version
12
+ *
13
+ * For a license to use the ser software under conditions
14
+ * other than those described here, or to purchase support for this
15
+ * software, please contact iptel.org by e-mail at the following addresses:
16
+ *    info@iptel.org
17
+ *
18
+ * sems is distributed in the hope that it will be useful,
19
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
20
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21
+ * GNU General Public License for more details.
22
+ *
23
+ * You should have received a copy of the GNU General Public License 
24
+ * along with this program; if not, write to the Free Software 
25
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26
+ */
27
+/** @file AmSipRequest.h */
1 28
 #ifndef AmSipRequest_h
2 29
 #define AmSipRequest_h
3 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmSmtpClient.h */
28 28
 #ifndef _AmSmtpClient_h_
29 29
 #define _AmSmtpClient_h_
30 30
 
... ...
@@ -1,3 +1,30 @@
1
+/*
2
+ * $Id$
3
+ *
4
+ * Copyright (C) 2002-2003 Fhg Fokus
5
+ *
6
+ * This file is part of sems, a free SIP media server.
7
+ *
8
+ * sems is free software; you can redistribute it and/or modify
9
+ * it under the terms of the GNU General Public License as published by
10
+ * the Free Software Foundation; either version 2 of the License, or
11
+ * (at your option) any later version
12
+ *
13
+ * For a license to use the ser software under conditions
14
+ * other than those described here, or to purchase support for this
15
+ * software, please contact iptel.org by e-mail at the following addresses:
16
+ *    info@iptel.org
17
+ *
18
+ * sems is distributed in the hope that it will be useful,
19
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
20
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21
+ * GNU General Public License for more details.
22
+ *
23
+ * You should have received a copy of the GNU General Public License 
24
+ * along with this program; if not, write to the Free Software 
25
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26
+ */
27
+/** @file AmStats.h */
1 28
 #ifndef _AmStats_h_
2 29
 #define _AmStats_h_
3 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmThread.h */
28 28
 #ifndef _AmThread_h_
29 29
 #define _AmThread_h_
30 30
 
... ...
@@ -24,7 +24,7 @@
24 24
  * along with this program; if not, write to the Free Software 
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27
-
27
+/** @file AmUAC.h */
28 28
 #ifndef AmUAC_H
29 29
 #define AmUAC_H
30 30
 
... ...
@@ -25,6 +25,8 @@
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/** @file AmUtils.cpp */
29
+
28 30
 #include "AmUtils.h"
29 31
 #include "AmThread.h"
30 32
 #include "AmConfig.h"
... ...
@@ -233,6 +233,7 @@ short get_port_v6(struct sockaddr_storage* ss);
233 233
  */
234 234
 int create_unix_socket(const string& path);
235 235
 
236
+/** \brief microseconds sleep using select */
236 237
 #define sleep_us(nusecs) \
237 238
 	{ \
238 239
 	struct timeval tval; \
... ...
@@ -247,12 +248,14 @@ int write_to_socket(int sd, const char* to_addr, const char * buf, unsigned int
247 248
 
248 249
 string extract_tag(const string& addr);
249 250
 
250
-// returns true if key is in s_list, a list of items delimited by list_delim
251
-// skips whitespaces, too
251
+/** returns true if key is in s_list, a list of items delimited by list_delim
252
+ *skips whitespaces, too */
252 253
 bool key_in_list(const string& s_list, const string& key, char list_delim = ',');
253
-// return string with trailing spaces and everything after ; including ; itself removed
254
+
255
+/** return string with trailing spaces and everything after ; including ; itself removed */
254 256
 string strip_header_params(const string& hdr_string);
255
-// get a header parameter value
257
+
258
+/** get a header parameter value */
256 259
 string get_header_param(const string& hdr_string, const string& param_name);
257 260
 
258 261
 /** get the value of key @param name from the list param_hdr*/
... ...
@@ -261,14 +264,15 @@ string get_header_keyvalue(const string& param_hdr, const string& name);
261 264
 /** get the value of key @param name from P-Iptel-Param header in hdrs */
262 265
 string get_session_param(const string& hdrs, const string& name);
263 266
 
264
-// support for thread-safe pseudo-random numbers
267
+/** support for thread-safe pseudo-random numbers  - init function */
265 268
 void init_random();
269
+/** support for thread-safe pseudo-random numbers  - make a random number function */
266 270
 unsigned int get_random();
267 271
 
268
-// Explode string by a separator to a vector
272
+/** Explode string by a separator to a vector */
269 273
 std::vector <string> explode(string s, string e);
270 274
 
271
-// add a directory to an environement variable
275
+/** add a directory to an environement variable */
272 276
 void add_env_path(const char* name, const string& path);
273 277
 
274 278
 #endif
... ...
@@ -31,8 +31,13 @@ deps: $(DEPS)
31 31
 
32 32
 .PHONY: doc
33 33
 doc:
34
-	rm -Rf doxygen_output; rm -rf ../doc/doxygen_doc ; \
35
-	doxygen doxygen_proj ; mv doxygen_output ../doc/doxygen_doc
34
+	rm -Rf doxygen_output; doxygen doxygen_proj ; \
35
+	rm -rf ../doc/doxygen_doc ; mv doxygen_output ../doc/doxygen_doc
36
+
37
+.PHONY: fulldoc
38
+fulldoc:
39
+	rm -Rf doxygen_output; doxygen doxygen_fulldoc ; \
40
+	rm -rf ../doc/doxygen_fulldoc ; mv doxygen_output ../doc/doxygen_fulldoc
36 41
 
37 42
 include ../Makefile.defs
38 43
 
... ...
@@ -77,9 +77,8 @@ extern "C" {
77 77
 struct amci_codec_t;
78 78
 
79 79
 /** 
80
- * File format declaration 
80
+ * \brief File format declaration 
81 81
  */
82
-
83 82
 struct amci_file_desc_t {
84 83
 
85 84
     /** subtype from current file format */
... ...
@@ -96,7 +95,7 @@ struct amci_file_desc_t {
96 95
 };
97 96
 
98 97
 /**
99
- * Sound converter function pointer.
98
+ * \brief Sound converter function pointer.
100 99
  * @param out      [out] output buffer
101 100
  * @param in       [in] input buffer
102 101
  * @param size     [in] size of input buffer
... ...
@@ -120,7 +119,7 @@ typedef int (*amci_converter_t)( unsigned char* out,
120 119
                                );
121 120
 
122 121
 /**
123
- * Codec specific packet loss concealment function pointer.
122
+ * \brief Codec specific packet loss concealment function pointer.
124 123
  * @param out      [out] output buffer
125 124
  * @param size     [in] required size of output
126 125
  * @param channels [in] number of channels
... ...
@@ -140,7 +139,7 @@ typedef int (*amci_plc_t)( unsigned char* out,
140 139
 			   long           h_codec );
141 140
 
142 141
 /**
143
- * File format handler's open function
142
+ * \brief File format handler's open function
144 143
  * @param fptr     [in] fresh opened file pointer
145 144
  * @param fmt_desc [out] file description
146 145
  * @param options  [in] options (see amci_inoutfmt_t)
... ...
@@ -210,7 +209,8 @@ typedef int (*amci_file_mem_close_t)( unsigned char* mptr,
210 209
                                   );
211 210
 
212 211
 /**
213
- * Codec's init function pointer.
212
+ * \brief Codec's init function pointer.
213
+ *
214 214
  * @param format_parameters  [in] parameters as passed by fmtp tag, 0 if none 
215 215
  * @param format_description [out] pointer to describing block, with amci_codec_fmt_info_t array; zero-terminated. 0 if none
216 216
  *   <table><tr><td><b>key</b></td><td><b>value</b></td></tr>
... ...
@@ -230,23 +230,23 @@ typedef int (*amci_file_mem_close_t)( unsigned char* mptr,
230 230
 typedef long (*amci_codec_init_t)(const char* format_parameters, amci_codec_fmt_info_t* format_description);
231 231
 
232 232
 /**
233
- * Codec's destroy function pointer.
233
+ * \brief Codec's destroy function pointer.
234 234
  * @param h_codec Codec handle (from init function).
235 235
  */
236 236
 typedef void (*amci_codec_destroy_t)(long h_codec);
237 237
 
238 238
 /**
239
- * Codec's function for calculating the number of samples from bytes
239
+ * \brief Codec's function for calculating the number of samples from bytes
240 240
  */
241 241
 typedef unsigned int (*amci_codec_bytes2samples_t)(long h_codec, unsigned int num_bytes);
242 242
 
243 243
 /**
244
- * Codec's function for calculating the number of bytes from samples
244
+ * \brief Codec's function for calculating the number of bytes from samples
245 245
  */
246 246
 typedef unsigned int (*amci_codec_samples2bytes_t)(long h_codec, unsigned int num_samples);
247 247
 
248 248
 /**
249
- * Codec description
249
+ * \brief Codec description
250 250
  */
251 251
 struct amci_codec_t {
252 252
 
... ...
@@ -276,7 +276,8 @@ struct amci_codec_t {
276 276
     /** Function for calculating the number of samples from bytes. */
277 277
     amci_codec_samples2bytes_t samples2bytes;
278 278
 };
279
-
279
+  
280
+  /** \brief supported subtypes for a file */
280 281
 struct amci_subtype_t {
281 282
 
282 283
     /** ex. 0x06 for Wav's Mu-Law */
... ...
@@ -304,7 +305,7 @@ struct amci_subtype_t {
304 305
 };
305 306
 
306 307
 /**
307
- * File format declaration.
308
+ * \brief File format declaration.
308 309
  */
309 310
 struct amci_inoutfmt_t {
310 311
 
... ...
@@ -340,7 +341,7 @@ struct amci_inoutfmt_t {
340 341
 #define AMCI_PT_AUDIO_FRAME 1
341 342
 
342 343
 /**
343
- * Payload declaration
344
+ * \brief ayload declaration
344 345
  */
345 346
 struct amci_payload_t {
346 347
 
... ...
@@ -374,7 +375,7 @@ struct amci_payload_t {
374 375
 
375 376
 
376 377
 /**
377
- * Complete plug-in declaration.
378
+ * \brief Complete plug-in declaration.
378 379
  */
379 380
 struct amci_exports_t {
380 381
 
... ...
@@ -32,6 +32,7 @@
32 32
  * @file codecs.h
33 33
  * Centralized definition of all codec IDs.
34 34
  * Look at the source file for declarations.
35
+ * they just need to be different from each other.
35 36
  */
36 37
 
37 38
 #define CODEC_PCM16   0
38 39
new file mode 100644
... ...
@@ -0,0 +1,227 @@
1
+# Doxyfile 1.5.1
2
+
3
+#---------------------------------------------------------------------------
4
+# Project related configuration options
5
+#---------------------------------------------------------------------------
6
+PROJECT_NAME           = SEMS
7
+PROJECT_NUMBER         = 
8
+OUTPUT_DIRECTORY       = doxygen_output
9
+CREATE_SUBDIRS         = NO
10
+OUTPUT_LANGUAGE        = English
11
+USE_WINDOWS_ENCODING   = NO
12
+BRIEF_MEMBER_DESC      = YES
13
+REPEAT_BRIEF           = YES
14
+ABBREVIATE_BRIEF       = 
15
+ALWAYS_DETAILED_SEC    = NO
16
+INLINE_INHERITED_MEMB  = NO
17
+FULL_PATH_NAMES        = NO
18
+STRIP_FROM_PATH        = 
19
+STRIP_FROM_INC_PATH    = 
20
+SHORT_NAMES            = NO
21
+JAVADOC_AUTOBRIEF      = NO
22
+MULTILINE_CPP_IS_BRIEF = NO
23
+DETAILS_AT_TOP         = NO
24
+INHERIT_DOCS           = YES
25
+SEPARATE_MEMBER_PAGES  = NO
26
+TAB_SIZE               = 8
27
+ALIASES                = 
28
+OPTIMIZE_OUTPUT_FOR_C  = NO
29
+OPTIMIZE_OUTPUT_JAVA   = NO
30
+BUILTIN_STL_SUPPORT    = YES
31
+DISTRIBUTE_GROUP_DOC   = NO
32
+SUBGROUPING            = YES
33
+#---------------------------------------------------------------------------
34
+# Build related configuration options
35
+#---------------------------------------------------------------------------
36
+EXTRACT_ALL            = YES
37
+EXTRACT_PRIVATE        = YES
38
+EXTRACT_STATIC         = YES
39
+EXTRACT_LOCAL_CLASSES  = YES
40
+EXTRACT_LOCAL_METHODS  = NO
41
+HIDE_UNDOC_MEMBERS     = NO
42
+HIDE_UNDOC_CLASSES     = NO
43
+HIDE_FRIEND_COMPOUNDS  = NO
44
+HIDE_IN_BODY_DOCS      = NO
45
+INTERNAL_DOCS          = NO
46
+CASE_SENSE_NAMES       = YES
47
+HIDE_SCOPE_NAMES       = NO
48
+SHOW_INCLUDE_FILES     = YES
49
+INLINE_INFO            = YES
50
+SORT_MEMBER_DOCS       = YES
51
+SORT_BRIEF_DOCS        = NO
52
+SORT_BY_SCOPE_NAME     = NO
53
+GENERATE_TODOLIST      = NO
54
+GENERATE_TESTLIST      = NO
55
+GENERATE_BUGLIST       = NO
56
+GENERATE_DEPRECATEDLIST= NO
57
+ENABLED_SECTIONS       = 
58
+MAX_INITIALIZER_LINES  = 30
59
+SHOW_USED_FILES        = YES
60
+SHOW_DIRECTORIES       = YES
61
+FILE_VERSION_FILTER    = 
62
+#---------------------------------------------------------------------------
63
+# configuration options related to warning and progress messages
64
+#---------------------------------------------------------------------------
65
+QUIET                  = NO
66
+WARNINGS               = YES
67
+WARN_IF_UNDOCUMENTED   = YES
68
+WARN_IF_DOC_ERROR      = YES
69
+WARN_NO_PARAMDOC       = NO
70
+WARN_FORMAT            = "$file:$line: $text"
71
+WARN_LOGFILE           = 
72
+#---------------------------------------------------------------------------
73
+# configuration options related to the input files
74
+#---------------------------------------------------------------------------
75
+INPUT                  =  ../core \
76
+		       ../apps \
77
+                       ../doc
78
+FILE_PATTERNS          = 
79
+RECURSIVE              = YES
80
+EXCLUDE                = 
81
+EXCLUDE_SYMLINKS       = NO
82
+EXCLUDE_PATTERNS       = 
83
+EXAMPLE_PATH           = ../doc ../apps ../core 
84
+EXAMPLE_PATTERNS       = 
85
+EXAMPLE_RECURSIVE      = YES
86
+IMAGE_PATH             = ../doc/figures/png/
87
+INPUT_FILTER           = 
88
+FILTER_PATTERNS        = 
89
+FILTER_SOURCE_FILES    = NO
90
+#---------------------------------------------------------------------------
91
+# configuration options related to source browsing
92
+#---------------------------------------------------------------------------
93
+SOURCE_BROWSER         = YES
94
+INLINE_SOURCES         = NO
95
+STRIP_CODE_COMMENTS    = YES
96
+REFERENCED_BY_RELATION = YES
97
+REFERENCES_RELATION    = YES
98
+REFERENCES_LINK_SOURCE = YES
99
+USE_HTAGS              = NO
100
+VERBATIM_HEADERS       = YES
101
+#---------------------------------------------------------------------------
102
+# configuration options related to the alphabetical class index
103
+#---------------------------------------------------------------------------
104
+ALPHABETICAL_INDEX     = NO
105
+COLS_IN_ALPHA_INDEX    = 5
106
+IGNORE_PREFIX          = 
107
+#---------------------------------------------------------------------------
108
+# configuration options related to the HTML output
109
+#---------------------------------------------------------------------------
110
+GENERATE_HTML          = YES
111
+HTML_OUTPUT            = html
112
+HTML_FILE_EXTENSION    = .html
113
+HTML_HEADER            = 
114
+HTML_FOOTER            = 
115
+HTML_STYLESHEET        = 
116
+HTML_ALIGN_MEMBERS     = YES
117
+GENERATE_HTMLHELP      = NO
118
+CHM_FILE               = 
119
+HHC_LOCATION           = 
120
+GENERATE_CHI           = NO
121
+BINARY_TOC             = NO
122
+TOC_EXPAND             = NO
123
+DISABLE_INDEX          = NO
124
+ENUM_VALUES_PER_LINE   = 4
125
+GENERATE_TREEVIEW      = NO
126
+TREEVIEW_WIDTH         = 250
127
+#---------------------------------------------------------------------------
128
+# configuration options related to the LaTeX output
129
+#---------------------------------------------------------------------------
130
+GENERATE_LATEX         = YES
131
+LATEX_OUTPUT           = latex
132
+LATEX_CMD_NAME         = latex
133
+MAKEINDEX_CMD_NAME     = makeindex
134
+COMPACT_LATEX          = NO
135
+PAPER_TYPE             = a4wide
136
+EXTRA_PACKAGES         = 
137
+LATEX_HEADER           = 
138
+PDF_HYPERLINKS         = NO
139
+USE_PDFLATEX           = NO
140
+LATEX_BATCHMODE        = NO
141
+LATEX_HIDE_INDICES     = NO
142
+#---------------------------------------------------------------------------
143
+# configuration options related to the RTF output
144
+#---------------------------------------------------------------------------
145
+GENERATE_RTF           = NO
146
+RTF_OUTPUT             = rtf
147
+COMPACT_RTF            = NO
148
+RTF_HYPERLINKS         = NO
149
+RTF_STYLESHEET_FILE    = 
150
+RTF_EXTENSIONS_FILE    = 
151
+#---------------------------------------------------------------------------
152
+# configuration options related to the man page output
153
+#---------------------------------------------------------------------------
154
+GENERATE_MAN           = NO
155
+MAN_OUTPUT             = man
156
+MAN_EXTENSION          = .3
157
+MAN_LINKS              = NO
158
+#---------------------------------------------------------------------------
159
+# configuration options related to the XML output
160
+#---------------------------------------------------------------------------
161
+GENERATE_XML           = NO
162
+XML_OUTPUT             = xml
163
+XML_SCHEMA             = 
164
+XML_DTD                = 
165
+XML_PROGRAMLISTING     = YES
166
+#---------------------------------------------------------------------------
167
+# configuration options for the AutoGen Definitions output
168
+#---------------------------------------------------------------------------
169
+GENERATE_AUTOGEN_DEF   = NO
170
+#---------------------------------------------------------------------------
171
+# configuration options related to the Perl module output
172
+#---------------------------------------------------------------------------
173
+GENERATE_PERLMOD       = NO
174
+PERLMOD_LATEX          = NO
175
+PERLMOD_PRETTY         = YES
176
+PERLMOD_MAKEVAR_PREFIX = 
177
+#---------------------------------------------------------------------------
178
+# Configuration options related to the preprocessor   
179
+#---------------------------------------------------------------------------
180
+ENABLE_PREPROCESSING   = YES
181
+MACRO_EXPANSION        = NO
182
+EXPAND_ONLY_PREDEF     = NO
183
+SEARCH_INCLUDES        = YES
184
+INCLUDE_PATH           = 
185
+INCLUDE_FILE_PATTERNS  = 
186
+PREDEFINED             = 
187
+EXPAND_AS_DEFINED      = 
188
+SKIP_FUNCTION_MACROS   = YES
189
+#---------------------------------------------------------------------------
190
+# Configuration::additions related to external references   
191
+#---------------------------------------------------------------------------
192
+TAGFILES               = 
193
+GENERATE_TAGFILE       = 
194
+ALLEXTERNALS           = NO
195
+EXTERNAL_GROUPS        = YES
196
+PERL_PATH              = /usr/bin/perl
197
+#---------------------------------------------------------------------------
198
+# Configuration options related to the dot tool   
199
+#---------------------------------------------------------------------------
200
+CLASS_DIAGRAMS         = NO
201
+HIDE_UNDOC_RELATIONS   = YES
202
+HAVE_DOT               = YES
203
+CLASS_GRAPH            = YES
204
+COLLABORATION_GRAPH    = YES
205
+GROUP_GRAPHS           = YES
206
+UML_LOOK               = NO
207
+TEMPLATE_RELATIONS     = YES
208
+INCLUDE_GRAPH          = YES
209
+INCLUDED_BY_GRAPH      = YES
210
+CALL_GRAPH             = NO
211
+CALLER_GRAPH           = NO
212
+GRAPHICAL_HIERARCHY    = YES
213
+DIRECTORY_GRAPH        = YES
214
+DOT_IMAGE_FORMAT       = png
215
+DOT_PATH               = 
216
+DOTFILE_DIRS           = 
217
+MAX_DOT_GRAPH_WIDTH    = 1024
218
+MAX_DOT_GRAPH_HEIGHT   = 1024
219
+MAX_DOT_GRAPH_DEPTH    = 0
220
+DOT_TRANSPARENT        = NO
221
+DOT_MULTI_TARGETS      = NO
222
+GENERATE_LEGEND        = YES
223
+DOT_CLEANUP            = YES
224
+#---------------------------------------------------------------------------
225
+# Configuration::additions related to the search engine   
226
+#---------------------------------------------------------------------------
227
+SEARCHENGINE           = NO
... ...
@@ -17,7 +17,7 @@
17