Commit 4451b27c authored by Alexandre Bourget's avatar Alexandre Bourget

Fix headers, copyright notices, and doxygen tags

Tiny doc fixes and typos.
parent afff570d
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......@@ -18,9 +19,7 @@
*/
#include "accountcreator.h"
#include "sipaccount.h"
#ifdef USE_IAX
#include "iaxaccount.h"
#endif
AccountCreator::AccountCreator()
{
......@@ -40,9 +39,7 @@ AccountCreator::createAccount(AccountType type, AccountID accountID)
break;
case IAX_ACCOUNT:
#ifdef USE_IAX
return new IAXAccount(accountID);
#endif
break;
}
return 0;
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......@@ -43,7 +44,7 @@ public:
static Account* createAccount(AccountType type, AccountID accountID);
private:
/** Hidden creator */
/** Hidden constructor */
AccountCreator();
};
......
/**
* Copyright (C) 2005 Savoir-Faire Linux inc.
/*
* Copyright (C) 2005-2007 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* Inspired by tonegenerator of
......
/**
* Copyright (C) 2005 Savoir-Faire Linux inc.
/*
* Copyright (C) 2005-2007 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* Inspired by tonegenerator of
......
/*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc.
* Copyright (C) 2004-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
*
......
/*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc.
* Copyright (C) 2004-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
*
......
/**
/*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
......
/**
/*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
......
/**
/*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc.
* Author:
*
......
/**
/*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
......
/**
/*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc.
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author : Laurielle Lea <laurielle.lea@savoirfairelinux.com>
......
/*
* Copyright (C) 2005 Savoir-Faire Linux inc.
* Copyright (C) 2005-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2005-2006 Savoir-Faire Linux inc.
* Copyright (C) 2005-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......@@ -64,7 +65,27 @@ public:
~ConfigTree();
void createSection(const std::string& section);
/**
* Return an array of strings, listing the sections of the config file
*
* This will be mainly used to filter which sections are an
* "Account" definition.
*
* @return array Strings of the sections
*/
TokenList getSections();
void addConfigTreeItem(const std::string& section, const ConfigTreeItem item);
/**
* Verify an item is there. If it's not, add it with the provided
* default value
*
* @param section Section
* @param
*/
void verifyConfigTreeItem(const std::string& section, const std::string& itemName,
const std::string& defaultValue, const std::string& type);
bool setConfigTreeItem(const std::string& section, const std::string& itemName, const std::string& value);
// throw a ConfigTreeItemException if not found
......
/*
* Copyright (C) 2007 Savoir-Faire Linux inc.
* Author: Pierre-Luc Beaudoin <pierre-luc.beaudoin@savoirfairelinux.com>
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
......
/*
* Copyright (C) 2007 Savoir-Faire Linux inc.
* Author: Pierre-Luc Beaudoin <pierre-luc.beaudoin@savoirfairelinux.com>
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2004-2005 Savoir-Faire Linux inc.
* Copyright (C) 2004-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
*
......
/*
* Copyright (C) 2004-2006 Savoir-Faire Linux inc.
* Copyright (C) 2004-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author : Laurielle Lea <laurielle.lea@savoirfairelinux.com>
*
* Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
......
......@@ -81,25 +81,29 @@ public:
ManagerImpl (void);
~ManagerImpl (void);
// Init a new VoIPLink, audio codec and audio driver
/**
* Initialisation of thread (sound) and map
* Initialisation of thread (sound) and map.
*
* Init a new VoIPLink, audio codec and audio driver
*/
void init (void);
/**
* Terminate all thread (sound, link) and clear map
* Terminate all thread (sound, link) and unload AccountMap
*/
void terminate (void);
/**
* Set the graphic user interface : only GuiServer right now
* @param gui A GuiFramework gui implmentation
* Set user interface manaager.
* @param man The DBUS interface implementation
*/
void setDBusManager (DBusManagerImpl* man) { _dbus = man; }
// Accessor to audiodriver
// it's multi-thread and use mutex internally
/**
* Accessor to audiodriver.
*
* it's multi-thread and use mutex internally
*/
AudioLayer* getAudioDriver(void) const { return _audiodriver; }
/**
......@@ -121,21 +125,29 @@ public:
void unmute();
bool refuseCall(const CallID& id);
/** Save config on file */
/** Save config to file */
bool saveConfig (void);
/**
* Initialize action (main thread)
* Send registration information (shake hands) for a specific AccountID
*
* @param accountId Account to register
* @return true if setRegister is call without failure, else return false
*/
bool registerVoIPLink(const AccountID& accountId);
/**
* Unregister an account
* Send unregistration for a specific account. If the protocol
* doesn't need to send anything, then the state of the account
* will be set to 'Unregistered', and related objects destroyed.
*
* @param accountId Account to unregister
* @return true if the unregister method is send correctly
*/
bool unregisterVoIPLink(const AccountID& accountId);
/**
* Undocumented
*/
bool sendTextMessage(const AccountID& accountId, const std::string& to, const std::string& message);
/*
......@@ -178,8 +190,15 @@ public:
void registrationFailed(const AccountID& accountId);
// configuration function requests
/** Start events thread*/
// TODO: receive account name
/**
* Start events thread. This function actually only calls the private
* initRegisterVoIPLink().
*
* This function should definitively be renamed!
*
* @todo Receive account name (???)
*/
bool getEvents();
//
......@@ -283,9 +302,12 @@ public:
*/
bool behindNat(const std::string& svr, int port);
/**
* Init default values for the different fields
*/
/**
* Init default values for the different fields in the config file.
* Fills the local _config (Conf::ConfigTree) with the default contents.
*
* Called in main.cpp, just before Manager::init().
*/
void initConfigFile (void);
/**
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2006 Savoir-Faire Linux inc.
* Copyright (C) 2006-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
*
* This program is free software; you can redistribute it and/or modify
......
/*
* Copyright (C) 2004-2006 Savoir-Faire Linux inc.
* Copyright (C) 2004-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author : Laurielle Lea <laurielle.lea@savoirfairelinux.com>
*
......
/*
* Copyright (C) 2004-2006 Savoir-Faire Linux inc.
* Copyright (C) 2004-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author : Laurielle Lea <laurielle.lea@savoirfairelinux.com>
*
......
/*
* Copyright (C) 2005-2006 Savoir-Faire Linux inc.
* Copyright (C) 2005-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author : Laurielle Lea <laurielle.lea@savoirfairelinux.com>
*
......
/*
* Copyright (C) 2005-2006 Savoir-Faire Linux inc.
* Copyright (C) 2005-2007 Savoir-Faire Linux inc.
* Author: Alexandre Bourget <alexandre.bourget@savoirfairelinux.com>
* Author: Yan Morin <yan.morin@savoirfairelinux.com>
* Author : Laurielle Lea <laurielle.lea@savoirfairelinux.com>
*
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment