Skip to content
Snippets Groups Projects
Commit 7675e328 authored by yanmorin's avatar yanmorin
Browse files

Documentation generation (remove copyright as doxygen brief summary)
doygen Doxyfile
parent f21092e5
No related branches found
No related tags found
No related merge requests found
...@@ -17,7 +17,7 @@ ...@@ -17,7 +17,7 @@
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project. # 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. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
......
...@@ -32,10 +32,10 @@ typedef std::string AccountID; ...@@ -32,10 +32,10 @@ typedef std::string AccountID;
/** /**
@author Yan Morin * Class account is an interface to protocol account (sipaccount, aixaccount)
Class account is an interface to protocol account (sipaccount, aixaccount) * It can be enable on loading or activate after.
It can be enable on loading or activate after. * It contains account, configuration, VoIP Link and Calls (inside the VoIPLink)
It contains account, configuration, VoIP Link and Calls (inside the VoIPLink) * @author Yan Morin
*/ */
class Account{ class Account{
public: public:
......
...@@ -24,8 +24,8 @@ ...@@ -24,8 +24,8 @@
class Account; 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{ class AccountCreator{
public: public:
......
/** /*
* 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: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
* *
...@@ -23,6 +23,9 @@ ...@@ -23,6 +23,9 @@
#include "audiocodec.h" #include "audiocodec.h"
/**
* Alaw audio codec (payload is 8)
*/
class Alaw : public AudioCodec { class Alaw : public AudioCodec {
public: public:
// payload should be 8 // payload should be 8
......
/** /*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc. * Copyright (C) 2004-2005-2006 Savoir-Faire Linux inc.
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
* *
* Portions Copyright (c) 2000 Billy Biggs <bbiggs@div8.net> * Portions Copyright (c) 2000 Billy Biggs <bbiggs@div8.net>
...@@ -26,6 +26,9 @@ ...@@ -26,6 +26,9 @@
#include "../global.h" #include "../global.h"
#include "dtmfgenerator.h" #include "dtmfgenerator.h"
/**
* DMTF library to generate a dtmf sample
*/
class DTMF { class DTMF {
public: public:
/** /**
......
/** /*
* 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: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
* *
...@@ -26,6 +26,9 @@ extern "C" { ...@@ -26,6 +26,9 @@ extern "C" {
#include "gsm/gsm.h" #include "gsm/gsm.h"
} }
/**
* GSM audio codec C++ class (over gsm/gsm.h)
*/
class Gsm : public AudioCodec { class Gsm : public AudioCodec {
public: public:
// _payload should be 3 // _payload should be 3
......
/** /*
* Copyright (C) 2005 Savoir-Faire Linux inc. * Copyright (C) 2005-2006 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Yan Morin <yan.morin@savoirfairelinux.com>
* *
* Inspired by tonegenerator of * Inspired by tonegenerator of
...@@ -29,6 +29,7 @@ ...@@ -29,6 +29,7 @@
#define TONE_NBCOUNTRY 7 #define TONE_NBCOUNTRY 7
/** /**
* Tone sample (dial, busy, ring, congestion)
* @author Yan Morin <yan.morin@savoirfairelinux.com> * @author Yan Morin <yan.morin@savoirfairelinux.com>
*/ */
class Tone : public AudioLoop { class Tone : public AudioLoop {
......
/** /*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc. * Copyright (C) 2004-2006 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
* *
...@@ -26,9 +26,9 @@ ...@@ -26,9 +26,9 @@
#include "../global.h" #include "../global.h"
/////////////////////////////////////////////////////////////////////////////// /**
// ToneGenerator * Sine generator to create tone with string definition
/////////////////////////////////////////////////////////////////////////////// */
class ToneGenerator { class ToneGenerator {
public: public:
ToneGenerator (unsigned int sampleRate); ToneGenerator (unsigned int sampleRate);
......
/** /*
* 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: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com> * Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
* *
...@@ -23,6 +23,9 @@ ...@@ -23,6 +23,9 @@
#include "audiocodec.h" #include "audiocodec.h"
/**
* Ulaw audio codec (payload = 0)
*/
class Ulaw : public AudioCodec { class Ulaw : public AudioCodec {
public: public:
// payload should be 0 // payload should be 0
......
...@@ -23,12 +23,11 @@ ...@@ -23,12 +23,11 @@
#include <string> #include <string>
#include <cc++/thread.h> // for mutex #include <cc++/thread.h> // for mutex
//TODO: remove this, it's only for call ID
typedef std::string CallID; 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{ class Call{
public: public:
......
/** /*
* Copyright (C) 2005 Savoir-Faire Linux inc. * Copyright (C) 2005 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Yan Morin <yan.morin@savoirfairelinux.com>
* *
......
/** /*
* Copyright (C) 2005 Savoir-Faire Linux inc. * Copyright (C) 2005-2006 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Yan Morin <yan.morin@savoirfairelinux.com>
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
...@@ -24,6 +24,9 @@ ...@@ -24,6 +24,9 @@
#include <string> #include <string>
#include <list> #include <list>
/**
* Configuration namespace for ConfigTree object (like .ini files)
*/
namespace Conf { namespace Conf {
class ConfigTreeItem; class ConfigTreeItem;
......
/** /*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc. * Copyright (C) 2004-2005 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com> (cc++ mutex) * Author: Yan Morin <yan.morin@savoirfairelinux.com> (cc++ mutex)
* Author: Jean-Philippe Barrette-LaPierre * Author: Jean-Philippe Barrette-LaPierre
...@@ -26,6 +26,9 @@ ...@@ -26,6 +26,9 @@
#include <string> #include <string>
#include <cc++/thread.h> #include <cc++/thread.h>
/**
* Pool Interface (multithread)
*/
template< typename T > template< typename T >
class ObjectPool class ObjectPool
{ {
......
...@@ -22,8 +22,8 @@ ...@@ -22,8 +22,8 @@
#include "account.h" #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 class IAXAccount : public Account
{ {
......
...@@ -25,9 +25,9 @@ ...@@ -25,9 +25,9 @@
class AudioCodec; class AudioCodec;
/** /**
@author Yan Morin <yan.morin@gmail.com> * VoIPLink contains a thread that listen to external events
VoIPLink contains a thread that listen to external events and * and contains IAX Call related functions
contains IAX Call related functions * @author Yan Morin <yan.morin@gmail.com>
*/ */
class IAXVoIPLink : public VoIPLink class IAXVoIPLink : public VoIPLink
{ {
......
...@@ -82,6 +82,9 @@ typedef std::set<CallID> CallIDSet; ...@@ -82,6 +82,9 @@ typedef std::set<CallID> CallIDSet;
*/ */
typedef std::list<std::string> TokenList; typedef std::list<std::string> TokenList;
/**
* Manager (controller) of sflphone daemon
*/
class ManagerImpl { class ManagerImpl {
public: public:
ManagerImpl (void); ManagerImpl (void);
......
/** /*
* Copyright (C) 2005 Savoir-Faire Linux inc. * Copyright (C) 2005-2006 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Yan Morin <yan.morin@savoirfairelinux.com>
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
......
/** /*
* Copyright (C) 2005 Savoir-Faire Linux inc. * Copyright (C) 2005-2006 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com> * Author: Yan Morin <yan.morin@savoirfairelinux.com>
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
...@@ -27,6 +27,9 @@ ...@@ -27,6 +27,9 @@
*/ */
namespace Pattern { namespace Pattern {
/**
* Observer interface
*/
class Observer { class Observer {
public: public:
virtual ~Observer() {}; virtual ~Observer() {};
......
...@@ -22,8 +22,8 @@ ...@@ -22,8 +22,8 @@
#include "account.h" #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 class SIPAccount : public Account
{ {
......
...@@ -27,8 +27,8 @@ ...@@ -27,8 +27,8 @@
class AudioCodec; 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 class SIPCall : public Call
{ {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment