From f47bd1aa2900974c0881dfbc74ecce154850f917 Mon Sep 17 00:00:00 2001
From: Emmanuel Lepage <emmanuel.lepage@savoirfairelinux.com>
Date: Mon, 12 Dec 2011 17:46:21 -0500
Subject: [PATCH] [ #7876 ] Add some doxygen
---
src/Account.h | 1 +
src/AccountList.h | 1 +
src/CallModel.h | 2 ++
src/Contact.h | 4 ++++
src/ContactBackend.h | 1 +
5 files changed, 9 insertions(+)
diff --git a/src/Account.h b/src/Account.h
index e70c39f7..7e572ac8 100644
--- a/src/Account.h
+++ b/src/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/src/AccountList.h b/src/AccountList.h
index dac4517d..540bae94 100644
--- a/src/AccountList.h
+++ b/src/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/src/CallModel.h b/src/CallModel.h
index 7bcbb27a..cf980237 100644
--- a/src/CallModel.h
+++ b/src/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/src/Contact.h b/src/Contact.h
index 5e03a500..ee1cd43e 100644
--- a/src/Contact.h
+++ b/src/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/src/ContactBackend.h b/src/ContactBackend.h
index a4a11806..cb5b3560 100644
--- a/src/ContactBackend.h
+++ b/src/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:
--
GitLab