@@ -106,6 +106,10 @@ bundle: ser-0.9.6-sems tar

 doc:

 	make -C core/ doc

+.PHONY: fulldoc

+fulldoc:

+	make -C core/ fulldoc

+

 .PHONY: install-ser-cfg

 install-ser-cfg:

 	make -C core/ install-ser-cfg

@@ -37,6 +37,7 @@

 #include <string>

 using std::string;

+/** \brief Factory for AnnounceB2B sessions */

 class AnnounceB2BFactory: public AmSessionFactory

 {

 public:

@@ -49,6 +50,7 @@ public:

   AmSession* onInvite(const AmSipRequest& req);

 };

+/** \brief Session logic implementation of A leg in announce_b2b sessions */

 class AnnounceCallerDialog: public AmB2BCallerSession

 {

   AmAudioFile wav_file;

@@ -35,6 +35,7 @@

 #include <string>

 using std::string;

+/** \brief session factory for announce_transfer sessions */

 class AnnounceTransferFactory: public AmSessionFactory

 {

 public:

@@ -47,6 +48,7 @@ public:

   AmSession* onInvite(const AmSipRequest& req);

 };

+/** \brief session logic implementation for announce_transfer sessions */

 class AnnounceTransferDialog : public AmSession

 {

   string callee_uri;

@@ -38,6 +38,7 @@ using std::string;

 #include <memory>

+/** \brief Factory for announcement sessions */

 class AnnouncementFactory: public AmSessionFactory

 {

   inline string getAnnounceFile(const AmSipRequest& req);

@@ -54,6 +55,7 @@ public:

 };

+/**\brief  announcement session logic implementation */

 class AnnouncementDialog : public AmSession,

 			   public CredentialHolder

 {

@@ -3,6 +3,7 @@

 #include "AmAudio.h"

+/** \brief audio device that generates ring tones with uesr specified period, f and f2 */

 class AmRingTone: public AmAudio

 {

   int on_period; // ms

@@ -59,6 +59,7 @@ enum { DoConfConnect = 100,

        DoConfError

 };

+/** \brief Event to trigger connecting/disconnecting between dialout session and main conference session */

 struct DialoutConfEvent : public AmEvent {

   string conf_id;

@@ -70,6 +71,7 @@ struct DialoutConfEvent : public AmEvent {

   {}

 };

+/** \brief Factory for conference sessions */

 class ConferenceFactory : public AmSessionFactory

 {

 public:

@@ -90,6 +92,7 @@ public:

   virtual int onLoad();

 };

+/** \brief session logic implementation of conference sessions */

 class ConferenceDialog : public AmSession

 {

   AmPlaylist  play_list;

@@ -34,6 +34,7 @@

 #include <string>

 using std::string;

+/** \brief Factory for early_announce sessions */

 class EarlyAnnounceFactory: public AmSessionFactory

 {

 public:

@@ -46,6 +47,7 @@ public:

   AmSession* onInvite(const AmSipRequest& req);

 };

+/** \brief session logic implementation for early_announce sessions */

 class EarlyAnnounceDialog : public AmSession

 {

   AmAudioFile wav_file;

@@ -40,6 +40,7 @@ using std::map;

 class IvrDialog;

+/** \brief C++ wrapper for extra thread created by Python IVR script */

 class PythonScriptThread : public AmThread {

   PyObject* py_thread_object;

  protected:

@@ -50,7 +51,7 @@ class PythonScriptThread : public AmThread {

    : py_thread_object(py_thread_object_) { }

 };

-

+/** \brief binds a script module and the python dialog class */

 struct IvrScriptDesc

 {

   PyObject* mod;

@@ -73,7 +74,7 @@ IvrScriptDesc(PyObject* mod,

   {}

 };

-

+/** \brief session factory for python IVR sessions */

 class IvrFactory: public AmSessionFactory

 {

   PyObject* ivr_module;

@@ -112,7 +113,7 @@ class IvrFactory: public AmSessionFactory

   void addDeferredThread(PyObject* pyCallable);

 };

-

+/** \brief python IVR wrapper for session base implementation */

 class IvrDialog : public AmB2BCallerSession

 {

   PyObject  *py_mod;

@@ -14,7 +14,7 @@

 #include "flite.h"

 #endif

-// Data definition

+/** \brief IVR wrapper of AmAudioFile */

 typedef struct {

   PyObject_HEAD

@@ -7,7 +7,7 @@

 #include "AmAudioMixIn.h"

-// Data definition

+/** \brief python IVR wrapper for AmAudioMixIn */ 

 typedef struct {

   PyObject_HEAD

@@ -1,15 +1,14 @@

 #include "IvrDialogBase.h"

 #include "IvrAudio.h"

 #include "IvrAudioMixIn.h"

-#

+

 #include "Ivr.h"

 #include "IvrSipDialog.h"

 #include "AmMediaProcessor.h"

-//#include "AmSessionTimer.h"

-// Data definition

+/** \brief python wrapper of IvrDialog, the base class for python IVR sessions */

 typedef struct {

   PyObject_HEAD

@@ -3,7 +3,7 @@

 #include "AmSipDialog.h"

 #include "log.h"

-// Data definition

+/** \brief IVR wrapper class of AmSipDialog */

 typedef struct {

   PyObject_HEAD

@@ -24,7 +24,7 @@

 #include "log.h"

-// Data definition

+/** \brief IVR wrapper of AmSipReply */

 typedef struct {

   PyObject_HEAD

@@ -25,6 +25,7 @@

 #include "log.h"

 // Data definition

+/** \brief IVR wrapper of AmSipRequest */

 typedef struct {

   PyObject_HEAD

@@ -27,7 +27,7 @@

 #include <Python.h>

 #include "structmember.h"

-// Data definition

+/** \brief python IVR wrapper for AmUAC functions */

 typedef struct {

   PyObject_HEAD

@@ -55,6 +55,12 @@ EXPORT_SESSION_FACTORY(PySemsFactory,MOD_NAME);

 PyMODINIT_FUNC initpy_sems_lib();

+/** 

+ * \brief gets python global interpreter lock (GIL)

+ * 

+ * structure to acquire the python global interpreter lock (GIL) 

+ * while the structure is allocated.

+ */

 struct PythonGIL

 {

   PyGILState_STATE gst;

@@ -76,6 +76,7 @@ PySemsScriptDesc(PyObject* mod,

 };

+/** \brief Factory for PySems sessions */

 class PySemsFactory: public AmSessionFactory

 {

   PyObject* py_sems_module;

@@ -110,6 +111,7 @@ class PySemsFactory: public AmSessionFactory

   AmSession* onInvite(const AmSipRequest& req);

 };

+/** \brief wrapper for pySems dialog bas class */

 class PySemsDialogBase {

   PyObject  *py_mod;

   PyObject  *py_dlg;

@@ -14,7 +14,7 @@

 #include "flite.h"

 #endif

-// Data definition

+/** \brief pySems wrapper for AmAudioFile  */

 typedef struct {

   PyObject_HEAD

@@ -29,6 +29,7 @@

 class PySemsB2ABCalleeDialog;

+/** \brief pySems wrapper for base of pySems dialog classes */

 class PySemsB2ABDialog : public AmB2ABCallerSession, 

   public PySemsDialogBase

 {

@@ -57,6 +58,7 @@ struct PySemsB2ABEvent: public B2ABEvent

   {}

 };

+/** \brief pySems wrapper for B leg in pysems B2AB session */

 class PySemsB2ABCalleeDialog : public AmB2ABCalleeSession

 {

  public:

@@ -28,6 +28,7 @@

 #include "AmB2BSession.h"

 #include "AmPlaylist.h"

+/** \brief IVR wrapper of AmB2BSession */

 class PySemsB2BDialog : public AmB2BCallerSession, 

   public PySemsDialogBase

 {

@@ -30,6 +30,7 @@

 #include "AmPlaylist.h"

 #include "PySems.h"

+/** \brief implementation of session logic/script execution in pySems */

 class PySemsDialog  :  public AmSession, 

   public PySemsDialogBase

 {

@@ -43,6 +43,7 @@ using std::string;

 class AmMail;

+/** \brief Factory for voicemail sessions */

 class AnswerMachineFactory: public AmSessionFactory

 {

   map<string, EmailTemplate> email_tmpl;

@@ -72,6 +73,7 @@ public:

   AmSession* onInvite(const AmSipRequest& req);

 };

+/** \brief implementation of voicemail session logic */

 class AnswerMachineDialog : public AmSession

 {

   AmAudioFile a_greeting,a_beep;

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmAdvancedAudio.h */

 #ifndef _AmAdvancedAudio_h_

 #define _AmAdvancedAudio_h_

@@ -87,6 +88,8 @@ class AmAudioQueue : public AmAudio {

 };

 /**

+ * \brief AmAudio device with a playlist and a background AmAudio

+ *

  * AmAudioFrontlist is an AmAudio device, that has a playlist

  * in front of a AmAudio entry, the 'back' device. The back device

  * is only used if the playlist is empty. - This can be useful when 

@@ -25,6 +25,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmApi.h */

 #ifndef _AmApi_h_

 #define _AmApi_h_

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmArg.h */

 #ifndef _AmArg_h_

 #define _AmArg_h_

@@ -34,7 +35,10 @@

 #include <vector>

 using std::vector;

-/** base for Objects as @see AmArg parameter, not owned by AmArg (!) */

+/** \brief base for Objects as @see AmArg parameter

+ * 

+ * not owned by AmArg (!) 

+ */

 class ArgObject {

  public:

   ArgObject() { }

@@ -57,10 +61,12 @@ class AmArg

     Array

   };

+  /** \brief exception thrown on access beyond array limits */

   struct OutOfBoundsException {

     OutOfBoundsException() { }

   };

+  /** \brief exception thrown if the on argument type mismatch */

   struct TypeMismatchException {

     TypeMismatchException() { }

   };

@@ -39,6 +39,7 @@

 #include <typeinfo>

+/** \brief structure to hold loaded codec instances */

 struct CodecContainer

 {

   amci_codec_t *codec;

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmAudio.h */

 #ifndef _AmAudio_h_

 #define _AmAudio_h_

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmAudioMixIn.h */

 #ifndef _AM_AUDIO_MIX_IN_H

 #define _AM_AUDIO_MIX_IN_H

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmB2ABSession.h */

 #ifndef B2ABSession_H

 #define B2ABSession_H

@@ -53,6 +54,7 @@ struct B2ABEvent: public AmEvent

   {}

 };

+/** \brief event fired if B leg is ringing in b2ab session */

 struct B2ABOtherLegRingingEvent: public B2ABEvent

 {

   B2ABOtherLegRingingEvent()

@@ -95,6 +97,7 @@ struct B2ABConnectLegEvent: public B2ABEvent

   {}

 };

+/** \brief event fired if an exception occured while creating B leg */

 struct B2ABConnectOtherLegExceptionEvent: public B2ABEvent {

   unsigned int code;

@@ -107,6 +110,7 @@ struct B2ABConnectOtherLegExceptionEvent: public B2ABEvent {

   {}

 };

+/** \brief event fired if the B leg could not be connected (e.g. busy) */

 struct B2ABConnectOtherLegFailedEvent: public B2ABEvent {

   unsigned int code;

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmB2BSession.h */

 #ifndef AmB2BSession_h

 #define AmB2BSession_h

@@ -52,7 +52,7 @@ AmFileCache::~AmFileCache() {

   }

 }

-int AmFileCache::load(const string& filename) {

+int AmFileCache::load(const std::string& filename) {

   int fd; 

   struct stat sbuf;

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmCachedAudioFile.h */

 #ifndef _AMFILECACHE_H

 #define _AMFILECACHE_H

@@ -33,6 +33,8 @@

 #include <string>

 /**

+ * \brief memory cache for AmAudioFile 

+ * 

  * The AmFileCache class loads a file once into memory 

  * to be used e.g. by AmCachedAudioFile.

  */

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmCallWatcher.h */

 #ifndef _AM_CALL_WATCHER_H

 #define _AM_CALL_WATCHER_H

@@ -54,7 +54,7 @@ using std::pair;

 class CallStatus;

 /** 

- * event that carries out call status update

+ * \brief event that carries out call status update

  */

 class CallStatusUpdateEvent : public AmEvent {

   string call_id;

@@ -82,7 +82,7 @@ class CallStatusUpdateEvent : public AmEvent {

 };

 /** 

- * interface for an update-able call status

+ * \brief interface for an update-able call status (AmCallWatcher)

  */

 class CallStatus

 {

@@ -100,6 +100,7 @@ class CallStatus

 class AmCallWatcherGarbageCollector;

 /**

+ * \brief manages call status to be queried by external processes 

  * call watcher is an entity for managing call status

  * via events that change status. Events are executed in a 

  * separate thread serially by processing the event queue, 

@@ -142,6 +143,8 @@ class AmCallWatcher

 };

 /** 

+ * \brief garbage collector for the AmCallWatcher

+ * 

  * checks garbage every two seconds. 

  * A bit inefficient with two threads, but AmCallWatcher

  * shouldn't be blocked by event.

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmConferenceChannel.h */

 #ifndef AmConferenceChannel_h

 #define AmConferenceChannel_h

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmConferenceStatus.h */

 #ifndef _ConferenceStatus_h_

 #define _ConferenceStatus_h_

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmConfig.h */

 #ifndef _AmConfig_h_

 #define _AmConfig_h_

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmConfigReader.h */

 #ifndef AmConfigReader_h

 #define AmConfigReader_h

@@ -1,3 +1,4 @@

+/** @file AmCtrlInterface.h */

 #ifndef AmCtrlInterface_h

 #define AmCtrlInterface_h

@@ -383,7 +383,7 @@ static int IVR_dtmf_matrix[4][4] =

 #define PI              3.1415926

 #define NELEMSOF(x) (sizeof(x)/sizeof(*x))

-

+/** \brief DTMF tone filter type */

 typedef struct {

   int freq;			/* frequency */

   int grp;			/* low/high group */

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmDtmfDetector.h */

 #ifndef _AmDtmfDetector_h_

 #define _AmDtmfDetector_h_

@@ -102,7 +103,7 @@ class AmDtmfEvent : public AmEvent

   int duration() const { return m_duration_msec; }

 };

 /**

- * this is the Interface for a sink for KeyPresses.

+ * \brief Interface for a sink for KeyPresses.

  */

 class AmKeyPressSink {

  public:

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmEvent.h */

 #ifndef AmEvent_h

 #define AmEvent_h

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmEventQueue.h */

 #ifndef _AMEVENTQUEUE_H_

 #define _AMEVENTQUEUE_H_

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmIcmpWatcher.h */

 #ifndef _AmIcmpWatcher_h_

 #define _AmIcmpWatcher_h_

@@ -25,7 +25,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmInterfaceHandler.h */

 #ifndef AmInterfaceHandler_h

 #define AmInterfaceHandler_h

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmJitterBuffer.h */

 #ifndef _AmJitterBuffer_h_

 #define _AmJitterBuffer_h_

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmMail.h */

 #ifndef _AmMail_h_

 #define _AmMail_h_

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmMediaProcessor.h */

 #ifndef _AmMediaProcessor_h_

 #define _AmMediaProcessor_h_

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmMultiPartyMixer.h */

 #ifndef _MultiPartyMixer_h_

 #define _MultiPartyMixer_h_

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmPlaylist.h */

 #ifndef AmPlaylist_h

 #define AmPlaylist_h

@@ -99,6 +99,8 @@ public:

 };

 /**

+ * \brief playlistelement to notify session about the playlist progress

+ *

  * null-playlist element which notifies session that this position in 

  * playlist is reached. It fies a AmPlaylistSeparatorEvent if it is 

  * read or written.

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmPlayoutBuffer.h */

 #ifndef _AmPlayoutBuffer_h_

 #define _AmPlayoutBuffer_h_

@@ -25,7 +25,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmPlugIn.h */

 #ifndef _AmPlugIn_h_

 #define _AmPlugIn_h_

@@ -25,11 +25,10 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmPromptCollection.h */

 #ifndef AM_PROMPT_COLLECTION_H

 #define AM_PROMPT_COLLECTION_H

-

 /**

  *

  * Example how to use:

@@ -108,7 +107,7 @@ class AmPromptCollection {

 };

 /** 

- *  AudioFile with filename 

+ *  \brief AmAudioFile with filename and open flag 

  */

 class AudioFileEntry : public AmAudioFile {

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmRtpAudio.h */

 #ifndef _AmRtpAudio_h_

 #define _AmRtpAudio_h_

@@ -24,6 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

+/** @file AmRtpPacket.h */

 #ifndef _AmRtpPacket_h_

 #define _AmRtpPacket_h_

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmRtpReceiver.h */

 #ifndef _AmRtpReceiver_h_

 #define _AmRtpReceiver_h_

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmRtpStream.h */

 #ifndef _RtpStream_h_

 #define _RtpStream_h_

@@ -243,6 +243,7 @@ public:

   virtual unsigned int bytes2samples(unsigned int) const = 0;

 };

+

 /** \brief represents info about an \ref AmRtpStream */

 struct AmRtpStreamInfo

 {

@@ -263,6 +264,7 @@ struct AmRtpStreamInfo

 		  AmAudio* audio_rec = NULL);

 };

+/** \brief event fired on RTP timeout */

 class AmRtpTimeoutEvent

   : public AmEvent

 {

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmServer.h */

 #ifndef _AmServer_h_

 #define _AmServer_h_

@@ -45,6 +45,7 @@ using std::greater;

 class AmCtrlInterface;

 class AmInterfaceHandler;

+/** \brief binds a AmCtrlInterface and an AmInterfaceHandler*/

 struct IfaceDesc

 {

   AmCtrlInterface*    ctrl;

@@ -119,7 +119,6 @@ bool AmSessionEventHandler::onSendReply(const AmSipRequest& req,

 #endif

-

 AmSession::AmSession()

   : AmEventQueue(this), // AmDialogState(),

     dlg(this),

@@ -51,6 +51,8 @@ using std::pair;

 class AmSessionFactory;

 class AmDtmfEvent;

+/** @file AmSession.h */

+

 /* definition imported from Ser parser/msg_parser.h */

 #define FL_FORCE_ACTIVE 2

@@ -24,7 +24,7 @@

  * along with this program; if not, write to the Free Software 

  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

  */

-

+/** @file AmSessionContainer.h */

 #ifndef AmSessionContainer_h

 #define AmSessionContainer_h

@@ -1,3 +1,30 @@

+/*

+ * $Id$

+ *

+ * Copyright (C) 2002-2003 Fhg Fokus