diff --git a/kde/src/AccountListModel.h b/kde/src/AccountListModel.h
index 41f99ad3665d52f835bab6eac22107c230e411f5..6fe1052817dafd06f3ce754fe9df6f5ab6ecd6cf 100755
--- a/kde/src/AccountListModel.h
+++ b/kde/src/AccountListModel.h
@@ -26,9 +26,7 @@
//SFLPhone
class ConfigAccountList;
-/**
- @author Jérémy Quentin <jeremy.quentin@gmail.com>
-*/
+///@class AccountListModel Model for the account list widget
class AccountListModel : public QAbstractListModel
{
Q_OBJECT
diff --git a/kde/src/AccountView.h b/kde/src/AccountView.h
index bb0e9a0fdf8b7fe7d0f506b90495ab160264c099..45b45152044be1a071d74a164c8941492a5e62fc 100644
--- a/kde/src/AccountView.h
+++ b/kde/src/AccountView.h
@@ -30,6 +30,7 @@ class QListWidgetItem;
//SFLPhone
class AccountItemWidget;
+///@class AccountView List widgets displaying accounts
class AccountView : public Account, public Item<AccountItemWidget> {
public:
//Constructor
diff --git a/kde/src/ActionSetAccountFirst.h b/kde/src/ActionSetAccountFirst.h
index eb323b4211a106740c20d30fd51c3732d4b8c737..291df3b4a34dfb2fca97b0e53e47742132d81515 100755
--- a/kde/src/ActionSetAccountFirst.h
+++ b/kde/src/ActionSetAccountFirst.h
@@ -26,19 +26,15 @@
#include "lib/Account.h"
-/**
- @author Jérémy Quentin <jeremy.quentin@savoirfairelinux.com>
-*/
+///@class ActionSetAccountFirst Set an account to be the first
class ActionSetAccountFirst : public QAction
{
Q_OBJECT
private:
-
- Account * account;
+ Account* account;
public:
-
ActionSetAccountFirst(Account * account, QObject *parent = 0);
~ActionSetAccountFirst();
diff --git a/kde/src/AkonadiBackend.h b/kde/src/AkonadiBackend.h
index b016a993c757fcfd4c7a2ad4cef1c32b7a5afe53..f1a383c256b3a090af1c9c79a5b6e422c7dc4f8e 100644
--- a/kde/src/AkonadiBackend.h
+++ b/kde/src/AkonadiBackend.h
@@ -43,6 +43,7 @@ class Contact;
typedef QList<Contact*> ContactList;
+///@class AkonadiBackend Implement a backend for Akonadi
class AkonadiBackend : public ContactBackend {
Q_OBJECT
public:
@@ -51,20 +52,24 @@ public:
Contact* getContactByUid ( QString uid );
void editContact ( Contact* contact );
void addNewContact ( Contact* contact );
+
private:
AkonadiBackend(QObject* parent);
virtual ~AkonadiBackend();
//Attributes
- static AkonadiBackend* m_pInstance ;
- Akonadi::Session* m_pSession ;
- Akonadi::Collection m_pCollection ;
- QHash<QString,KABC::Addressee> m_pAddrHash ;
+ static AkonadiBackend* m_pInstance ;
+ Akonadi::Session* m_pSession ;
+ Akonadi::Collection m_pCollection ;
+ QHash<QString,KABC::Addressee> m_pAddrHash ;
+
protected:
ContactList update_slot();
+
public slots:
ContactList update(Akonadi::Collection collection);
void collectionsReceived( const Akonadi::Collection::List& );
+
signals:
void collectionChanged();
};
diff --git a/kde/src/CallView.h b/kde/src/CallView.h
index 228ba09abae08243d4e343b02e8f401977ea454b..920874fdd8d0b5d189b8c5172b19b70d662e2465 100644
--- a/kde/src/CallView.h
+++ b/kde/src/CallView.h
@@ -30,6 +30,7 @@ class QTreeWidgetItem;
//SFLPhone
class CallTreeItem;
+///@class CallTreeItemDelegate Delegates for CallTreeItem
class CallTreeItemDelegate : public QItemDelegate
{
public:
@@ -44,7 +45,8 @@ class CallTreeItemDelegate : public QItemDelegate
typedef CallModel<CallTreeItem*,QTreeWidgetItem*> TreeWidgetCallModel;
-class CallView : public QTreeWidget/*, public TreeWidgetCallModel*/ {
+///@class CallView Central tree widget managing active calls
+class CallView : public QTreeWidget {
Q_OBJECT
public:
CallView ( QWidget* parent = 0 );
diff --git a/kde/src/Codec.h b/kde/src/Codec.h
index c48a00efa07bba3c560d5c3af79f48905c3ec219..2a36b3f2f80fe240d56d4fa1127a19ab6a2d2fe0 100755
--- a/kde/src/Codec.h
+++ b/kde/src/Codec.h
@@ -26,9 +26,7 @@
//Qt
class QString;
-/**
- @author Jérémy Quentin <jeremy.quentin@gmail.com>
-*/
+///@class Codec A SIP codec
class Codec : public QObject
{
Q_OBJECT
diff --git a/kde/src/SFLPhoneapplication.h b/kde/src/SFLPhoneapplication.h
index cd8e45eca38aec96923dd9e4ed45fec206b8eb4b..1c182147ae74acd7e1ea267f6feab4c4db6626a4 100755
--- a/kde/src/SFLPhoneapplication.h
+++ b/kde/src/SFLPhoneapplication.h
@@ -7,6 +7,7 @@
//SFLPhone
class SFLPhone;
+///@class SFLPhoneApplication Main application
class SFLPhoneApplication : public KApplication
{
Q_OBJECT
diff --git a/kde/src/conf/ConfigAccountList.h b/kde/src/conf/ConfigAccountList.h
index ebe17365ab33e7076eeda0405fc6743a480b5ca3..a8a57b21474b5d39e3251a83b3c2201595ed7613 100644
--- a/kde/src/conf/ConfigAccountList.h
+++ b/kde/src/conf/ConfigAccountList.h
@@ -4,6 +4,7 @@
#include "../lib/AccountList.h"
#include "../AccountView.h"
+///@class ConfigAccountList Account list model
class ConfigAccountList : public QObject {
Q_OBJECT
public:
diff --git a/kde/src/conf/dlgaccounts.h b/kde/src/conf/dlgaccounts.h
index 413205bce3fc8c5c6f74a95ca32e787da8836195..8043481fac1b52bc7722c3782d1b3cbda4d21ed6 100755
--- a/kde/src/conf/dlgaccounts.h
+++ b/kde/src/conf/dlgaccounts.h
@@ -46,6 +46,7 @@ typedef QHash<QString, QString> StringHash; //Needed to
typedef QHash<QListWidgetItem*, CredentialData> QListWidgetItemHash; //Needed to fix a Qt foreach macro argument parsing bug
typedef QList<CredentialData> CredentialList;
+///@class Private_AddCodecDialog Little dialog to add codec to the list
class Private_AddCodecDialog : public KDialog {
Q_OBJECT
public:
diff --git a/kde/src/lib/Account.h b/kde/src/lib/Account.h
index e70c39f796ffe513eedf657864f2b23cd654871d..7e572ac87d53d41ad5abe0d9f3d0aa864fe1889f 100644
--- a/kde/src/lib/Account.h
+++ b/kde/src/lib/Account.h
@@ -29,6 +29,7 @@ class QString;
const QString account_state_name(QString & s);
+///@class Account a daemon account (SIP or AIX)
class LIB_EXPORT Account : public QObject {
Q_OBJECT
diff --git a/kde/src/lib/AccountList.h b/kde/src/lib/AccountList.h
index dac4517d9f64eff89c63e5480ec2dc7c745bba91..540bae94179c0876c79399acb5c7ab6de6bddfd9 100644
--- a/kde/src/lib/AccountList.h
+++ b/kde/src/lib/AccountList.h
@@ -28,6 +28,7 @@
#include "Account.h"
#include "typedefs.h"
+///@class AccountList List of all daemon accounts
class LIB_EXPORT AccountList : public QObject{
Q_OBJECT
diff --git a/kde/src/lib/CallModel.h b/kde/src/lib/CallModel.h
index 7bcbb27a10926e036d1d96be1809a5fb5f789bf8..cf9802375857dd217af46e76a83099a6a8917e0a 100644
--- a/kde/src/lib/CallModel.h
+++ b/kde/src/lib/CallModel.h
@@ -40,6 +40,7 @@ class ContactBackend;
typedef QHash<QString, Call*> CallHash;
typedef QList<Call*> CallList;
+///@class CallModelBase Base class for the central model/frontend
///This class need to exist because template classes can't have signals ans
///slots because Qt MOC generator can't guess the type at precompilation
class LIB_EXPORT CallModelBase : public QObject
@@ -82,6 +83,7 @@ signals:
* with the MVC model. The MVC never got to a point were it was bug-free and the code was getting dirty. The Mirror model
* solution may be less "clean" than MVC, but is 3 time smaller and easier to improve (in fact, possible to improve).
*/
+///@class CallModel Central model/frontend to deal with sflphoned
template <typename CallWidget, typename Index>
class LIB_EXPORT CallModel : public CallModelBase {
public:
diff --git a/kde/src/lib/Contact.h b/kde/src/lib/Contact.h
index 5e03a500a70cc0c171e62f50f1e53be9d2747713..ee1cd43e0e62f748db0d8c7767ca50c5c0f2856d 100644
--- a/kde/src/lib/Contact.h
+++ b/kde/src/lib/Contact.h
@@ -38,6 +38,7 @@ namespace KABC {
#include "typedefs.h"
/**
+ * @class Contact Abstract version of a contact
@author Jérémy Quentin <jeremy.quentin@savoirfairelinux.com>
@author Emmanuel Lepage <emmanuel.lepage@savoirfairelinux.com>
*/
@@ -54,10 +55,12 @@ public:
QString& getType() {
return m_pType ;
}
+
private:
QString m_pNumber ;
QString m_pType ;
};
+
typedef QList<Contact::PhoneNumber*> PhoneNumbers;
private:
@@ -72,6 +75,7 @@ private:
QString m_pUid ;
bool displayPhoto ;
PhoneNumbers m_pNumbers ;
+
public:
//Constructors & Destructors
explicit Contact();
diff --git a/kde/src/lib/ContactBackend.h b/kde/src/lib/ContactBackend.h
index a4a1180676a667fb61a653c1dd4a2794f4cb9844..cb5b3560850693b1c165ecab08d0c86de4821f04 100644
--- a/kde/src/lib/ContactBackend.h
+++ b/kde/src/lib/ContactBackend.h
@@ -32,6 +32,7 @@ class Contact;
typedef QList<Contact*> ContactList;
+///@class ContactBackend Allow different way to handle contact without poluting the library
class LIB_EXPORT ContactBackend : public QObject {
Q_OBJECT
public:
diff --git a/kde/src/widgets/AccountItemWidget.h b/kde/src/widgets/AccountItemWidget.h
index 9ab9e5ab98ff6478ca8c713d588ffec141904c2b..a6ca3e1653afc9f2519778c425c3394641536b06 100755
--- a/kde/src/widgets/AccountItemWidget.h
+++ b/kde/src/widgets/AccountItemWidget.h
@@ -27,23 +27,13 @@
#include <QLabel>
#include <kled.h>
-/**
- @author Jérémy Quentin <jeremy.quentin@savoirfairelinux.com>
-*/
+///@class AccountItemWidget Widget for the config dialog account list
class AccountItemWidget : public QWidget
{
Q_OBJECT
-private:
-
- int state;
- bool enabled;
- QLabel * led;
- QCheckBox * checkBox;
- QLabel * textLabel;
-
public:
-
+ //Enum
enum State {Registered, Unregistered, NotWorking};
//Constructors & Destructors
@@ -64,6 +54,14 @@ public:
void updateEnabledDisplay ();
void updateDisplay ();
+private:
+ //Attributes
+ int state;
+ bool enabled;
+ QLabel* led;
+ QCheckBox* checkBox;
+ QLabel* textLabel;
+
private slots:
void on_checkBox_stateChanged(int state);
diff --git a/kde/src/widgets/BookmarkDock.h b/kde/src/widgets/BookmarkDock.h
index 77b47a6757253f23df32e5a25db785e5da2ce124..384df1d341d815d102948f24af262b968fa05c8e 100644
--- a/kde/src/widgets/BookmarkDock.h
+++ b/kde/src/widgets/BookmarkDock.h
@@ -32,10 +32,14 @@ class KLineEdit;
//SFLPhone
class HistoryTreeItem;
+//Typedef
typedef QList<HistoryTreeItem*> BookmarkList;
+
+///@class BookmarkDock Dock for managing favorite contacts
class BookmarkDock : public QDockWidget {
Q_OBJECT
public:
+ //Constructors
BookmarkDock(QWidget* parent);
virtual ~BookmarkDock();
diff --git a/kde/src/widgets/CallTreeItem.h b/kde/src/widgets/CallTreeItem.h
index 2410281e30a2adfb7b5903d4b2ff366f9dc80fea..e3bcce1dc2a7995fcf1c6ab461e437c75d18204d 100644
--- a/kde/src/widgets/CallTreeItem.h
+++ b/kde/src/widgets/CallTreeItem.h
@@ -36,6 +36,7 @@ class KIcon;
//SFLPhone
class Call;
+///@class CallTreeItem Widget for the central call treeview
class CallTreeItem : public QWidget
{
Q_OBJECT
diff --git a/kde/src/widgets/ContactDock.h b/kde/src/widgets/ContactDock.h
index 5eccdf2e4df7a869dd7fe4c4aade6336d476671a..15eb3b6a12f478174ba0409fc2de2cd2d96dc7e8 100644
--- a/kde/src/widgets/ContactDock.h
+++ b/kde/src/widgets/ContactDock.h
@@ -50,6 +50,7 @@ namespace KABC {
class ContactTree;
class ContactItemWidget;
+///@class ContactDock Dock to access contacts
class ContactDock : public QDockWidget
{
Q_OBJECT
diff --git a/kde/src/widgets/ContactItemWidget.h b/kde/src/widgets/ContactItemWidget.h
index 15f21f76bcd77f61c17a1c98d62d9b9e7f501f60..ca2e464c02364075e19145501c233f20ec86280c 100644
--- a/kde/src/widgets/ContactItemWidget.h
+++ b/kde/src/widgets/ContactItemWidget.h
@@ -40,6 +40,7 @@ namespace KABC {
//SFLPhone
class Contact;
+///@class ContactItemWidget Item for the contact tree
class ContactItemWidget : public QWidget
{
Q_OBJECT
diff --git a/kde/src/widgets/Dialpad.h b/kde/src/widgets/Dialpad.h
index c7a1fe03f4c217d9c07b61d617315373aaf70cab..95177e0fae134c2155279e0ecf94c71a6e215a11 100755
--- a/kde/src/widgets/Dialpad.h
+++ b/kde/src/widgets/Dialpad.h
@@ -17,7 +17,7 @@
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
- ***************************************************************************/
+ **************************************************************************/
#ifndef DIALPAD_H
#define DIALPAD_H
@@ -27,11 +27,8 @@
class QPushButton;
class QGridLayout;
-/**
-A widget that represents a phone dialpad, with numbers and letters associated.
- @author Jérémy Quentin <jeremy.quentin@gmail.com>
-*/
+///@class Dialpad A widget that representing a phone dialpad with associated numbers and letters
class Dialpad : public QWidget
{
Q_OBJECT
diff --git a/kde/src/widgets/HistoryDock.h b/kde/src/widgets/HistoryDock.h
index f114270e8b83db0b3a87fefbe8d1f803a8ce3a54..e74e9cc250eab08fcdffadf5768a3a8c9c5290cf 100644
--- a/kde/src/widgets/HistoryDock.h
+++ b/kde/src/widgets/HistoryDock.h
@@ -42,8 +42,10 @@ class KDateWidget;
class HistoryTreeItem;
class HistoryTree;
+//Typedef
typedef QList<HistoryTreeItem*> HistoryList;
+///@class HistoryDock Dock to see the previous SFLPhone calls
class HistoryDock : public QDockWidget {
Q_OBJECT
diff --git a/kde/src/widgets/HistoryTreeItem.h b/kde/src/widgets/HistoryTreeItem.h
index 7a125f8d0937758f2299c6a163cd14fc8926abc3..b5cf04f582779a38929f834f111131e1c6c07ff2 100644
--- a/kde/src/widgets/HistoryTreeItem.h
+++ b/kde/src/widgets/HistoryTreeItem.h
@@ -41,6 +41,7 @@ class QLabel;
//KDE
class KAction;
+///@class HistoryTreeItem Items for the history dock
class HistoryTreeItem : public QWidget
{
Q_OBJECT
diff --git a/kde/src/widgets/SFLPhoneTray.h b/kde/src/widgets/SFLPhoneTray.h
index bd134b7294af0a24c6bc453cdc1e3309e12dc686..697679e0a3f5d94902dad644c3fde2a50a9a67f8 100755
--- a/kde/src/widgets/SFLPhoneTray.h
+++ b/kde/src/widgets/SFLPhoneTray.h
@@ -31,6 +31,7 @@ class KAction;
class QMenu;
class QIcon;
+///@class SFLPhoneTray The old system try, should be totally replaced by a plasmoid some day
class SFLPhoneTray : public KSystemTrayIcon
{
Q_OBJECT