diff --git a/Doxyfile b/Doxyfile index cf70b8dea6d2408ce3fec0ed0ecb47066d82a6b2..6b4470767c45191a07091cab0a59998fb2b9284a 100644 --- a/Doxyfile +++ b/Doxyfile @@ -17,7 +17,7 @@ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = "SFLphone Deamon" +PROJECT_NAME = "SFLphone" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or diff --git a/src/account.h b/src/account.h index a2ab5f6932659818b34e4eb29bd87d3aa43342e4..40586b50938929f1cd12f3f68b258e6dd2a9c0dc 100644 --- a/src/account.h +++ b/src/account.h @@ -32,11 +32,11 @@ typedef std::string AccountID; /** - @author Yan Morin - Class account is an interface to protocol account (sipaccount, aixaccount) - It can be enable on loading or activate after. - It contains account, configuration, VoIP Link and Calls (inside the VoIPLink) -*/ + * Class account is an interface to protocol account (sipaccount, aixaccount) + * It can be enable on loading or activate after. + * It contains account, configuration, VoIP Link and Calls (inside the VoIPLink) + * @author Yan Morin + */ class Account{ public: Account(const AccountID& accountID); diff --git a/src/accountcreator.h b/src/accountcreator.h index cb156358b19e136a9ed540eccce5bf12299572e8..0023c4e3888d3977f87a01cd8c51bb52c903d724 100644 --- a/src/accountcreator.h +++ b/src/accountcreator.h @@ -24,9 +24,9 @@ class Account; /** - @author Yan Morin <yan.morin@gmail.com> - AccountCreator create Protocol-specific Account -*/ + * AccountCreator create Protocol-specific Account + * @author Yan Morin <yan.morin@gmail.com> + */ class AccountCreator{ public: ~AccountCreator(); diff --git a/src/audio/alaw.h b/src/audio/alaw.h index c418a887724b784bb159debe30956a4c5c75a7ee..3ebad55604fcf34e76560ee11133f893a316703d 100644 --- a/src/audio/alaw.h +++ b/src/audio/alaw.h @@ -1,5 +1,5 @@ -/** - * Copyright (C) 2004-2005 Savoir-Faire Linux inc. +/* + * Copyright (C) 2004-2005-2006 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * @@ -23,6 +23,9 @@ #include "audiocodec.h" +/** + * Alaw audio codec (payload is 8) + */ class Alaw : public AudioCodec { public: // payload should be 8 diff --git a/src/audio/dtmf.h b/src/audio/dtmf.h index 183d2fe14c9251b3984bd39b501f87627033f085..ef20ba74c0ed78d7a0142f2d3a58db5bac864b4b 100644 --- a/src/audio/dtmf.h +++ b/src/audio/dtmf.h @@ -1,5 +1,5 @@ -/** - * Copyright (C) 2004-2005 Savoir-Faire Linux inc. +/* + * Copyright (C) 2004-2005-2006 Savoir-Faire Linux inc. * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * * Portions Copyright (c) 2000 Billy Biggs <bbiggs@div8.net> @@ -26,6 +26,9 @@ #include "../global.h" #include "dtmfgenerator.h" +/** + * DMTF library to generate a dtmf sample + */ class DTMF { public: /** diff --git a/src/audio/gsmcodec.h b/src/audio/gsmcodec.h index 9f21aca8c7299722c8046d0cb2778829e08086c5..d531e6e4f3b8f052d65db1d199a1a6dd3c860607 100644 --- a/src/audio/gsmcodec.h +++ b/src/audio/gsmcodec.h @@ -1,5 +1,5 @@ -/** - * Copyright (C) 2004-2005 Savoir-Faire Linux inc. +/* + * Copyright (C) 2004-2005-2006 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * @@ -26,6 +26,9 @@ extern "C" { #include "gsm/gsm.h" } +/** + * GSM audio codec C++ class (over gsm/gsm.h) + */ class Gsm : public AudioCodec { public: // _payload should be 3 diff --git a/src/audio/tone.h b/src/audio/tone.h index 42d0dfe833e5f32ca608444a47160ab261aea0ba..0604bd300b44386f4e7ea4b19bfef7af333df7df 100644 --- a/src/audio/tone.h +++ b/src/audio/tone.h @@ -1,5 +1,5 @@ -/** - * Copyright (C) 2005 Savoir-Faire Linux inc. +/* + * Copyright (C) 2005-2006 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> * * Inspired by tonegenerator of @@ -29,6 +29,7 @@ #define TONE_NBCOUNTRY 7 /** + * Tone sample (dial, busy, ring, congestion) * @author Yan Morin <yan.morin@savoirfairelinux.com> */ class Tone : public AudioLoop { diff --git a/src/audio/tonegenerator.h b/src/audio/tonegenerator.h index 968c5946b42b0f9fbafb1aff1a26117b3b109fd3..9a3bcdeba233aa70d365337e2ce0b1cf35c953f7 100644 --- a/src/audio/tonegenerator.h +++ b/src/audio/tonegenerator.h @@ -1,5 +1,5 @@ -/** - * Copyright (C) 2004-2005 Savoir-Faire Linux inc. +/* + * Copyright (C) 2004-2006 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * @@ -26,9 +26,9 @@ #include "../global.h" -/////////////////////////////////////////////////////////////////////////////// -// ToneGenerator -/////////////////////////////////////////////////////////////////////////////// +/** + * Sine generator to create tone with string definition + */ class ToneGenerator { public: ToneGenerator (unsigned int sampleRate); diff --git a/src/audio/ulaw.h b/src/audio/ulaw.h index a515d9bfad73299ae629a98a43581629593c2088..3ec369f6916bc1a10a28d8eead22a2032f7b0fad 100644 --- a/src/audio/ulaw.h +++ b/src/audio/ulaw.h @@ -1,5 +1,5 @@ -/** - * Copyright (C) 2004-2005 Savoir-Faire Linux inc. +/* + * Copyright (C) 2004-2005-2006 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * @@ -23,6 +23,9 @@ #include "audiocodec.h" +/** + * Ulaw audio codec (payload = 0) + */ class Ulaw : public AudioCodec { public: // payload should be 0 diff --git a/src/call.h b/src/call.h index 1f260825e7dbc7b3adc34568b393f9dfbac1c4f7..bd8bdc39c89f7013b88a6f3785372269feaaad35 100644 --- a/src/call.h +++ b/src/call.h @@ -23,13 +23,12 @@ #include <string> #include <cc++/thread.h> // for mutex -//TODO: remove this, it's only for call ID typedef std::string CallID; /** - @author Yan Morin <yan.morin@gmail.com> - A call is the base classes for protocol-based calls -*/ + * A call is the base classes for protocol-based calls + * @author Yan Morin <yan.morin@gmail.com> + */ class Call{ public: enum CallType {Incoming, Outgoing}; diff --git a/src/config/config.cpp b/src/config/config.cpp index 6e0018e57b870cb52f0e66de05c9ec7adf867a3d..76aa490fc913b3d74a4a1c21bd23437e87c65d1f 100644 --- a/src/config/config.cpp +++ b/src/config/config.cpp @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2005 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> * diff --git a/src/config/config.h b/src/config/config.h index b09e3094394755ab23726079b95f281fde6fdf90..9171470c081ca23a006dfc20c8b6adcc9a5d715c 100644 --- a/src/config/config.h +++ b/src/config/config.h @@ -1,5 +1,5 @@ -/** - * Copyright (C) 2005 Savoir-Faire Linux inc. +/* + * Copyright (C) 2005-2006 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> * * This program is free software; you can redistribute it and/or modify @@ -24,6 +24,9 @@ #include <string> #include <list> +/** + * Configuration namespace for ConfigTree object (like .ini files) + */ namespace Conf { class ConfigTreeItem; diff --git a/src/gui/server/ObjectPool.hpp b/src/gui/server/ObjectPool.hpp index fa1f19af9a30c017beb00915dbbe0fad093ec554..f9c25bad5748da2aa258256bd08c5da0d2a7f27e 100644 --- a/src/gui/server/ObjectPool.hpp +++ b/src/gui/server/ObjectPool.hpp @@ -1,4 +1,4 @@ -/** +/* * Copyright (C) 2004-2005 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> (cc++ mutex) * Author: Jean-Philippe Barrette-LaPierre @@ -26,6 +26,9 @@ #include <string> #include <cc++/thread.h> +/** + * Pool Interface (multithread) + */ template< typename T > class ObjectPool { diff --git a/src/iaxaccount.h b/src/iaxaccount.h index 3780d166d9b04b5068dd7c472a129c578800f9a7..4b79f9860c98774ec52453aeab44cac63baa5ea1 100644 --- a/src/iaxaccount.h +++ b/src/iaxaccount.h @@ -22,9 +22,9 @@ #include "account.h" /** - @author Yan Morin <yan.morin@gmail.com> - An IAX Account specify IAX specific functions and objects (IAXCall/IAXVoIPLink) -*/ + * An IAX Account specify IAX specific functions and objects (IAXCall/IAXVoIPLink) + * @author Yan Morin <yan.morin@gmail.com> + */ class IAXAccount : public Account { public: diff --git a/src/iaxvoiplink.h b/src/iaxvoiplink.h index 56f9755cfd5d568b64106777acee5d67eeb5c9b2..9f29e97567d5deff406ab38f4df1bc11d513db53 100644 --- a/src/iaxvoiplink.h +++ b/src/iaxvoiplink.h @@ -25,10 +25,10 @@ class AudioCodec; /** - @author Yan Morin <yan.morin@gmail.com> - VoIPLink contains a thread that listen to external events and - contains IAX Call related functions -*/ + * VoIPLink contains a thread that listen to external events + * and contains IAX Call related functions + * @author Yan Morin <yan.morin@gmail.com> + */ class IAXVoIPLink : public VoIPLink { public: diff --git a/src/managerimpl.h b/src/managerimpl.h index 90f379499cad922b1fac599d1a797f1a08eeeba9..e12c51908e22d43b9aeb2d73efda9ad34c844948 100644 --- a/src/managerimpl.h +++ b/src/managerimpl.h @@ -82,12 +82,15 @@ typedef std::set<CallID> CallIDSet; */ typedef std::list<std::string> TokenList; +/** + * Manager (controller) of sflphone daemon + */ class ManagerImpl { public: ManagerImpl (void); ~ManagerImpl (void); - // Init a new VoIPLink, audio codec and audio driver + // Init a new VoIPLink, audio codec and audio driver /** * Initialisation of thread (sound) and map */ diff --git a/src/observer.cpp b/src/observer.cpp index 022c3316a50dfc2c2c4636c56e6325e2c3347cb9..d7343b3aaac1199cfadebf5b1c49baf6346009c3 100644 --- a/src/observer.cpp +++ b/src/observer.cpp @@ -1,5 +1,5 @@ -/** - * Copyright (C) 2005 Savoir-Faire Linux inc. +/* + * Copyright (C) 2005-2006 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> * * This program is free software; you can redistribute it and/or modify diff --git a/src/observer.h b/src/observer.h index 785cba8741a1e4ad6d1c9dbf44c48882ee46cd36..71b44d339c770d14dd9f39e969b8042c5fdf8f05 100644 --- a/src/observer.h +++ b/src/observer.h @@ -1,5 +1,5 @@ -/** - * Copyright (C) 2005 Savoir-Faire Linux inc. +/* + * Copyright (C) 2005-2006 Savoir-Faire Linux inc. * Author: Yan Morin <yan.morin@savoirfairelinux.com> * * This program is free software; you can redistribute it and/or modify @@ -27,6 +27,9 @@ */ namespace Pattern { +/** + * Observer interface + */ class Observer { public: virtual ~Observer() {}; diff --git a/src/sipaccount.h b/src/sipaccount.h index c5da7b18fe833a28525af96b300d5dfcac390e8c..e2bf11e66e333886280922b2054c666dfbcacd7b 100644 --- a/src/sipaccount.h +++ b/src/sipaccount.h @@ -22,8 +22,8 @@ #include "account.h" /** - @author Yan Morin <yan.morin@gmail.com> - A Sip Account specify SIP specific functions and object (SIPCall/SIPVoIPLink) + * A Sip Account specify SIP specific functions and object (SIPCall/SIPVoIPLink) + * @author Yan Morin <yan.morin@gmail.com> */ class SIPAccount : public Account { diff --git a/src/sipcall.h b/src/sipcall.h index cbe640a055f25aea066e14bedd060e2df4adb50b..1bd9413515cb430a3ec8488c5bb44192d6e5cf8a 100644 --- a/src/sipcall.h +++ b/src/sipcall.h @@ -27,9 +27,9 @@ class AudioCodec; /** - @author Yan Morin <yan.morin@gmail.com> - SIPCall are SIP implementation of a normal Call -*/ + * SIPCall are SIP implementation of a normal Call + * @author Yan Morin <yan.morin@gmail.com> + */ class SIPCall : public Call { public: diff --git a/src/sipvoiplink.h b/src/sipvoiplink.h index 4c67fee05c3a607569d235458c2158f489e11547..65ebc4010d1010c51f0d7331eb1cd3471db0dbb3 100644 --- a/src/sipvoiplink.h +++ b/src/sipvoiplink.h @@ -29,8 +29,9 @@ class EventThread; class SIPCall; /** - @author Yan Morin <yan.morin@gmail.com> -*/ + * Specific VoIPLink for SIP (SIP core for incoming and outcoming events) + * @author Yan Morin <yan.morin@gmail.com> + */ class SIPVoIPLink : public VoIPLink { public: diff --git a/src/voIPLink.h b/src/voIPLink.h index e0644bb2209303eb9d6eafd034da63fed2c62624..9f74bdbeb0345b1f942c162ac5c8ca011bcff479 100644 --- a/src/voIPLink.h +++ b/src/voIPLink.h @@ -31,6 +31,9 @@ class AudioCodec; typedef std::map<CallID, Call*> CallMap; +/** + * Listener and manager interface for each VoIP protocol + */ class VoIPLink { public: VoIPLink(const AccountID& accountID);