diff --git a/core/AmAdvancedAudio.h b/core/AmAdvancedAudio.h index 53629822..eaeba06b 100644 --- a/core/AmAdvancedAudio.h +++ b/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 { diff --git a/core/AmAudio.h b/core/AmAudio.h index 30ce1cf3..7364f530 100644 --- a/core/AmAudio.h +++ b/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.
+ * \brief base for classes that input or output audio. + * + * AmAudio binds a format and converts the samples if needed. *
Internal Format: PCM signed 16 bit (mono | stereo). */ diff --git a/core/AmCmd.h b/core/AmCmd.h index 8b940f28..e1b5fdb0 100644 --- a/core/AmCmd.h +++ b/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 { diff --git a/core/AmConfig.h b/core/AmConfig.h index 44d9c1a5..23df253f 100644 --- a/core/AmConfig.h +++ b/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 diff --git a/core/AmCtrlInterface.h b/core/AmCtrlInterface.h index 3f12eb20..cdb75323 100644 --- a/core/AmCtrlInterface.h +++ b/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; * */ -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 u_data; diff --git a/core/AmDtmfDetector.h b/core/AmDtmfDetector.h index 09802d64..e20c75c9 100644 --- a/core/AmDtmfDetector.h +++ b/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 { diff --git a/core/AmMail.h b/core/AmMail.h index d4f04165..6f097e0c 100644 --- a/core/AmMail.h +++ b/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. */ diff --git a/core/AmPlugIn.h b/core/AmPlugIn.h index c85b5e2f..5871ba37 100644 --- a/core/AmPlugIn.h +++ b/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 { diff --git a/core/AmRtpPacket.h b/core/AmRtpPacket.h index 80de19b7..de359317 100644 --- a/core/AmRtpPacket.h +++ b/core/AmRtpPacket.h @@ -33,7 +33,7 @@ class AmRtpPacketTracer; -/** RTP packet implementation */ +/** \brief RTP packet implementation */ class AmRtpPacket { unsigned char buffer[4096]; diff --git a/core/AmRtpReceiver.h b/core/AmRtpReceiver.h index 0fcca4e8..6b368735 100644 --- a/core/AmRtpReceiver.h +++ b/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. diff --git a/core/AmRtpStream.h b/core/AmRtpStream.h index 12da93ae..0c3169fc 100644 --- a/core/AmRtpStream.h +++ b/core/AmRtpStream.h @@ -63,6 +63,8 @@ class SdpPayload; typedef map JitterBuffer; /** + * \brief RTP implementation + * * Rtp stream high level interface. */ class AmRtpStream diff --git a/core/AmSdp.h b/core/AmSdp.h index b582acde..120b3ca3 100644 --- a/core/AmSdp.h +++ b/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 { diff --git a/core/AmSession.h b/core/AmSession.h index 7b8a7eca..c8c2b43b 100644 --- a/core/AmSession.h +++ b/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 diff --git a/core/AmSessionContainer.h b/core/AmSessionContainer.h index da38990e..a550246f 100644 --- a/core/AmSessionContainer.h +++ b/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 diff --git a/core/AmSmtpClient.h b/core/AmSmtpClient.h index a17eb237..9e9f9c46 100644 --- a/core/AmSmtpClient.h +++ b/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 diff --git a/core/AmThread.h b/core/AmThread.h index 1f821526..01b4be7b 100644 --- a/core/AmThread.h +++ b/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 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.