Skip to content
Snippets Groups Projects
Commit f47bd1aa authored by Emmanuel Lepage's avatar Emmanuel Lepage
Browse files

[ #7876 ] Add some doxygen

parent 46ff1e09
No related branches found
No related tags found
No related merge requests found
...@@ -29,6 +29,7 @@ class QString; ...@@ -29,6 +29,7 @@ class QString;
const QString account_state_name(QString & s); const QString account_state_name(QString & s);
///@class Account a daemon account (SIP or AIX)
class LIB_EXPORT Account : public QObject { class LIB_EXPORT Account : public QObject {
Q_OBJECT Q_OBJECT
......
...@@ -28,6 +28,7 @@ ...@@ -28,6 +28,7 @@
#include "Account.h" #include "Account.h"
#include "typedefs.h" #include "typedefs.h"
///@class AccountList List of all daemon accounts
class LIB_EXPORT AccountList : public QObject{ class LIB_EXPORT AccountList : public QObject{
Q_OBJECT Q_OBJECT
......
...@@ -40,6 +40,7 @@ class ContactBackend; ...@@ -40,6 +40,7 @@ class ContactBackend;
typedef QHash<QString, Call*> CallHash; typedef QHash<QString, Call*> CallHash;
typedef QList<Call*> CallList; 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 ///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 ///slots because Qt MOC generator can't guess the type at precompilation
class LIB_EXPORT CallModelBase : public QObject class LIB_EXPORT CallModelBase : public QObject
...@@ -82,6 +83,7 @@ signals: ...@@ -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 * 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). * 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> template <typename CallWidget, typename Index>
class LIB_EXPORT CallModel : public CallModelBase { class LIB_EXPORT CallModel : public CallModelBase {
public: public:
......
...@@ -38,6 +38,7 @@ namespace KABC { ...@@ -38,6 +38,7 @@ namespace KABC {
#include "typedefs.h" #include "typedefs.h"
/** /**
* @class Contact Abstract version of a contact
@author Jérémy Quentin <jeremy.quentin@savoirfairelinux.com> @author Jérémy Quentin <jeremy.quentin@savoirfairelinux.com>
@author Emmanuel Lepage <emmanuel.lepage@savoirfairelinux.com> @author Emmanuel Lepage <emmanuel.lepage@savoirfairelinux.com>
*/ */
...@@ -54,10 +55,12 @@ public: ...@@ -54,10 +55,12 @@ public:
QString& getType() { QString& getType() {
return m_pType ; return m_pType ;
} }
private: private:
QString m_pNumber ; QString m_pNumber ;
QString m_pType ; QString m_pType ;
}; };
typedef QList<Contact::PhoneNumber*> PhoneNumbers; typedef QList<Contact::PhoneNumber*> PhoneNumbers;
private: private:
...@@ -72,6 +75,7 @@ private: ...@@ -72,6 +75,7 @@ private:
QString m_pUid ; QString m_pUid ;
bool displayPhoto ; bool displayPhoto ;
PhoneNumbers m_pNumbers ; PhoneNumbers m_pNumbers ;
public: public:
//Constructors & Destructors //Constructors & Destructors
explicit Contact(); explicit Contact();
......
...@@ -32,6 +32,7 @@ class Contact; ...@@ -32,6 +32,7 @@ class Contact;
typedef QList<Contact*> ContactList; typedef QList<Contact*> ContactList;
///@class ContactBackend Allow different way to handle contact without poluting the library
class LIB_EXPORT ContactBackend : public QObject { class LIB_EXPORT ContactBackend : public QObject {
Q_OBJECT Q_OBJECT
public: public:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment