more doxygen documentation

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

core/AmAdvancedAudio.h

@@ -85,6 +85,8 @@ protected:
 };
 
 /**
+ * \brief \ref AmAudio that directly connects input and output
+ *
  *  AmAudioBridge simply connects input and output
  *  This is useful e.g. at the end of a AudioQueue
  */
@@ -99,6 +101,7 @@ protected:
 };
 
 /**
+ * \brief \ref AmAudio that delays output from input
  * delays delay_sec seconds (up to ~2)
  */
 class AmAudioDelay : public AmAudio {

core/AmAudio.h

@@ -60,6 +60,7 @@ public:
 
 
 /**
+ * \brief double buffer with back and front
  * Implements double buffering.
  */
 
@@ -147,7 +148,7 @@ private:
     void operator = (const AmAudioFormat& r);
 };
 
-/** \brief simple audio format */
+/** \brief simple \ref AmAudioFormat audio format */
 class AmAudioSimpleFormat: public AmAudioFormat
 {
     int codec_id;
@@ -159,7 +160,7 @@ public:
     AmAudioSimpleFormat(int codec_id);
 };
 
-/** \brief file audio format */
+/** \brief \ref AmAudioFormat for file */
 class AmAudioFileFormat: public AmAudioFormat
 {
     /** == "" if not yet initialized. */
@@ -231,9 +232,9 @@ public:
 };
 
 /**
- * AmAudio binds an input and an output format together.
- * It converts also the samples if needed, 
- * depending on the input/output formats.<br>
+ * \brief base for classes that input or output audio.
+ *
+ * AmAudio binds a format and converts the samples if needed.
  * <br>Internal Format: PCM signed 16 bit (mono | stereo).
  */
 

core/AmCmd.h

@@ -35,7 +35,8 @@ using std::string;
 #define FL_FORCE_ACTIVE 2
 
 /**
- * Structure to store the FIFO parameters.
+ * \brief represents a command received from \ref AmCtrlInterface
+ * Structure to store the parameters.
  */
 struct AmCmd 
 {

core/AmConfig.h

@@ -38,6 +38,8 @@ using std::map;
 class AmSessionTimerConfig;
 
 /**
+ * \brief holds the current configuration.
+ *
  * This Structure holds the current configuration.
  */
 struct AmConfig

core/AmCtrlInterface.h

@@ -18,7 +18,20 @@ using std::auto_ptr;
 #define CTRL_MSGBUF_SIZE 2048
 #define MAX_MSG_ERR         5
 
+/** \brief user data in a \ref AmCtrlInterface */
+class AmCtrlUserData
+{
+public:
+    virtual ~AmCtrlUserData(){}
+};
+
 /**
+ * \brief Base class for the control interfaces.
+ * 
+ * The AmCtrlInterface defines the interface for 
+ * SER-SEMS communication interface (unix socket/fifo). 
+ *
+ *
  * The FIFO / Unix socket Server.
  * 
  * Enables Ser to send request throught FIFO file.
@@ -43,19 +56,6 @@ using std::auto_ptr;
  *   </pre>
  */
 
-class AmCtrlUserData
-{
-public:
-    virtual ~AmCtrlUserData(){}
-};
-
-/**
- * \brief Base class for the control interfaces.
- * 
- * The AmCtrlInterface defines the interface for 
- * SER-SEMS communication interface (unix socket/fifo). 
- */
-
 class AmCtrlInterface
 {
     auto_ptr<AmCtrlUserData> u_data;

core/AmDtmfDetector.h

@@ -46,6 +46,8 @@ namespace Dtmf
     enum EventSource { SOURCE_RTP, SOURCE_SIP, SOURCE_INBAND, SOURCE_DETECTOR };
 };
 /**
+ * \brief sink for audio to be processed by the inband DTMF detector 
+ * 
  * This class adds processing of timeouts for DTMF detection
  */
 class AmDtmfEventQueue : public AmEventQueue
@@ -63,7 +65,7 @@ public:
 };
 
 /**
- * Base class for DTMF events
+ * \brief Base class for DTMF events
  */
 class AmDtmfEvent : public AmEvent
 {
@@ -101,7 +103,7 @@ public:
 };
 
 /**
- * DTMF received via RTP
+ * \brief DTMF received via RTP
  */
 class AmRtpDtmfEvent : public AmDtmfEvent
 {
@@ -134,7 +136,7 @@ public:
 };
 
 /**
- * DTMF received via SIP INFO request
+ * \brief DTMF received via SIP INFO request
  */
 class AmSipDtmfEvent : public AmDtmfEvent
 {

core/AmMail.h

@@ -39,7 +39,7 @@ using std::vector;
 using std::queue;
 
 /**
- * Email file attachement
+ * \brief Email file attachement
  */
 struct Attachement
 {
@@ -70,7 +70,7 @@ class AmMail;
 typedef void (*MailCleanUpFunction)(AmMail* mail);
 
 /**
- * Email structure.
+ * \brief Email structure.
  * Supports basic email functions such as attachements.
  */
 struct AmMail
@@ -98,7 +98,7 @@ public:
 };
 
 /**
- * Email Deamon.
+ * \brief Email Deamon (singleton).
  * It is designed as a singleton using a queue to get his work.
  * It wakes up only if there is anything to do.
  */

core/AmPlugIn.h

@@ -47,7 +47,7 @@ struct amci_inoutfmt_t;
 struct amci_subtype_t;
 
 /**
- * Container for loaded Plug-ins.
+ * \brief Container for loaded Plug-ins.
  */
 class AmPlugIn
 {

core/AmRtpPacket.h

@@ -33,7 +33,7 @@
 
 class AmRtpPacketTracer;
 
-/** RTP packet implementation */
+/** \brief RTP packet implementation */
 class AmRtpPacket {
 
     unsigned char  buffer[4096];

core/AmRtpReceiver.h

@@ -39,7 +39,8 @@ using std::greater;
 class AmRtpStream;
 
 /**
- * \brief receiver for RTP for all streams
+ * \brief receiver for RTP for all streams.
+ *
  * The RtpReceiver receives RTP packets for all streams 
  * that are registered to it. It places the received packets in 
  * the stream's buffer. 

core/AmRtpStream.h

@@ -63,6 +63,8 @@ class SdpPayload;
 typedef map<unsigned int, AmRtpPacket, ts_less> JitterBuffer;
 
 /**
+ * \brief RTP implementation
+ *
  * Rtp stream high level interface.
  */
 class AmRtpStream 

core/AmSdp.h

@@ -55,7 +55,7 @@ enum MediaType { MT_NONE=0, MT_AUDIO, MT_VIDEO, MT_APPLICATION, MT_DATA };
 /** transport protocol */
 enum TransProt { TP_NONE=0, TP_RTPAVP, TP_UDP };
 
-/** c=... line */
+/** \brief c=... line in SDP*/
 struct SdpConnection
 {
     /** @see NetworkType */
@@ -68,7 +68,7 @@ struct SdpConnection
     SdpConnection() : address() {}
 };
 
-/** o=... line */
+/** \brief o=... line in SDP */
 struct SdpOrigin
 {
     string user;
@@ -78,6 +78,7 @@ struct SdpOrigin
 };
 /** 
  * \brief sdp payload
+ *
  * this binds together pt, name, rate and parameters
  */
 struct SdpPayload
@@ -99,7 +100,7 @@ struct SdpPayload
 };
 
 
-/** m=... line */
+/** \brief m=... line in SDP */
 struct SdpMedia
 {
     enum Direction {
@@ -120,7 +121,7 @@ struct SdpMedia
 };
 
 /**
- * The SDP parser class.
+ * \brief The SDP parser class.
  */
 class AmSdp
 {

core/AmSession.h

@@ -68,6 +68,8 @@ public:
 
 
 /**
+ * \brief Interface for SIP events signaling plugins implement
+ *
  *  Signaling plugins must inherite from this class.
  */
 class AmSessionEventHandler

core/AmSessionContainer.h

@@ -15,7 +15,8 @@ using std::queue;
 using std::map;
 
 /**
- * Centralized session container.
+ * \brief Centralized session container.
+ *
  * This is the register for all active and dead sessions.
  * If has a deamon which wakes up only if it has work. 
  * Then, it kills all dead sessions and try to go to bed 

core/AmSmtpClient.h

@@ -42,7 +42,7 @@ using std::vector;
 #define SMTP_LINE_BUFFER  512
 
 /**
- * SMTP client implementation class
+ * \brief SMTP client implementation
  * 
  */
 class AmSmtpClient

core/AmThread.h

@@ -34,7 +34,7 @@
 using std::queue;
 
 /**
- * C++ Wrapper class for pthread mutex
+ * \brief C++ Wrapper class for pthread mutex
  */
 class AmMutex
 {
@@ -48,7 +48,7 @@ public:
 };
 
 /**
- * Simple lock class
+ * \brief  Simple lock class
  */
 class AmLock
 {
@@ -63,7 +63,8 @@ public:
 };
 
 /**
- * Shared variable.
+ * \brief Shared variable.
+ *
  * Include a variable and its mutex.
  * @warning Don't use safe functions (set,get)
  * within a {lock(); ... unlock();} block. Use 
@@ -100,7 +101,7 @@ public:
 };
 
 /**
- * C++ Wrapper class for pthread condition
+ * \brief C++ Wrapper class for pthread condition
  */
 template<class T>
 class AmCondition
@@ -154,7 +155,7 @@ public:
 };
 
 /**
- * C++ Wrapper class for pthread
+ * \brief C++ Wrapper class for pthread
  */
 class AmThread
 {
@@ -191,6 +192,8 @@ class AmThread
 };
 
 /**
+ * \brief Container/garbage collector for threads. 
+ * 
  * AmThreadWatcher waits for threads to stop
  * and delete them.
  * It gets started automatically when needed.