jami/jami-daemon
1
0
Fork 0
mirror of https://git.jami.net/savoirfairelinux/jami-daemon.git synced 2025-08-12 22:09:25 +08:00
Code Issues Projects Releases Wiki Activity

Documentation generation (remove copyright as doxygen brief summary)

Browse Source 
doygen Doxyfile
This commit is contained in:
yanmorin
2006-04-09 22:44:09 +00:00
parent f21092e597
commit 7675e32896
22 changed files with 79 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Doxyfile
View File

@ -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

10
src/account.h
View File

@ -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);

6
src/accountcreator.h
View File

@ -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();

7
src/audio/alaw.h
View File

@ -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

7
src/audio/dtmf.h
View File

@ -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:
/**

7
src/audio/gsmcodec.h
View File

@ -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

5
src/audio/tone.h
View File

@ -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 {

10
src/audio/tonegenerator.h
View File

@ -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);

7
src/audio/ulaw.h
View File

@ -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

7
src/call.h
View File

@ -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};

2
src/config/config.cpp
View File

@ -1,4 +1,4 @@
/**
/*
* Copyright (C) 2005 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*

7
src/config/config.h
View File

@ -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;

5
src/gui/server/ObjectPool.hpp
View File

@ -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
{

6
src/iaxaccount.h
View File

@ -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:

8
src/iaxvoiplink.h
View File

@ -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:

5
src/managerimpl.h
View File

@ -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
*/

4
src/observer.cpp
View File

@ -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

7
src/observer.h
View File

@ -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() {};

4
src/sipaccount.h
View File

@ -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
{

6
src/sipcall.h
View File

@ -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:

5
src/sipvoiplink.h
View File

@ -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:

3
src/voIPLink.h
View File

@ -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);