[ #7876 ] Add some doxygen

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

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

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

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

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

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

kde/src/SFLPhoneapplication.h

@@ -7,6 +7,7 @@
 //SFLPhone
 class SFLPhone;
 
+///@class SFLPhoneApplication Main application
 class SFLPhoneApplication : public KApplication
 {
   Q_OBJECT

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:

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:

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
 

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

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:

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

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:

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

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

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

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

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

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