From 51941ca7ccaa6675edba570b75f7ba6bddf3eac4 Mon Sep 17 00:00:00 2001
From: Emmanuel Lepage <emmanuel.lepage@savoirfairelinux.com>
Date: Thu, 14 Jun 2012 16:16:35 -0400
Subject: [PATCH] [ #12352 ] Fix doxygen (1/3)
---
kde/src/AccountListModel.h | 2 +-
kde/src/AccountView.h | 2 +-
kde/src/ActionSetAccountFirst.h | 2 +-
kde/src/CallView.cpp | 2 +-
kde/src/CallView.h | 4 ++--
kde/src/Codec.h | 2 +-
kde/src/SFLPhoneAccessibility.cpp | 8 +++++++-
kde/src/SFLPhoneAccessibility.h | 1 +
kde/src/SFLPhoneView.cpp | 18 +-----------------
kde/src/SFLPhoneView.h | 8 --------
kde/src/SFLPhoneapplication.h | 2 +-
kde/src/conf/ConfigAccountList.h | 2 +-
kde/src/conf/dlgaccessibility.h | 2 +-
kde/src/conf/dlgaccounts.h | 4 ++--
kde/src/conf/dlgvideo.h | 2 +-
kde/src/klib/AkonadiBackend.cpp | 2 +-
kde/src/klib/AkonadiBackend.h | 2 +-
kde/src/klib/HelperFunctions.h | 2 +-
kde/src/klib/SortableDockCommon.h | 4 ++--
kde/src/klib/dataengine/sflphonEngine.h | 1 +
kde/src/klib/dataengine/sflphoneService.h | 14 +++++++-------
kde/src/lib/Account.h | 2 +-
kde/src/lib/AccountList.cpp | 4 ++--
kde/src/lib/AccountList.h | 2 +-
kde/src/lib/CallModel.h | 4 ++--
kde/src/lib/Contact.h | 2 +-
kde/src/lib/ContactBackend.h | 2 +-
kde/src/lib/HistoryModel.cpp | 1 +
kde/src/lib/HistoryModel.h | 2 +-
kde/src/lib/VideoCodec.h | 2 +-
kde/src/lib/VideoDevice.h | 2 +-
kde/src/lib/VideoModel.h | 2 +-
kde/src/widgets/AccountItemWidget.h | 2 +-
kde/src/widgets/BookmarkDock.cpp | 2 +-
kde/src/widgets/BookmarkDock.h | 2 +-
kde/src/widgets/CallTreeItem.h | 2 +-
kde/src/widgets/CategorizedTreeWidget.h | 1 +
kde/src/widgets/CategoryDrawer.h | 1 +
kde/src/widgets/ContactDock.cpp | 2 +-
kde/src/widgets/ContactDock.h | 6 +++---
kde/src/widgets/ContactItemWidget.h | 2 +-
kde/src/widgets/Dialpad.h | 4 ++--
kde/src/widgets/HistoryDock.cpp | 2 +-
kde/src/widgets/HistoryDock.h | 6 +++---
kde/src/widgets/HistoryTreeItem.cpp | 1 +
kde/src/widgets/HistoryTreeItem.h | 2 +-
kde/src/widgets/SFLPhoneTray.h | 2 +-
kde/src/widgets/TranslucentButtons.h | 2 +-
kde/src/widgets/VideoWidget.h | 1 +
49 files changed, 70 insertions(+), 81 deletions(-)
diff --git a/kde/src/AccountListModel.h b/kde/src/AccountListModel.h
index 7d5546362f..08e9d4117a 100755
--- a/kde/src/AccountListModel.h
+++ b/kde/src/AccountListModel.h
@@ -26,7 +26,7 @@
//SFLPhone
class ConfigAccountList;
-///@class AccountListModel Model for the account list widget
+/// 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 5f29748cef..c7e562e25d 100644
--- a/kde/src/AccountView.h
+++ b/kde/src/AccountView.h
@@ -30,7 +30,7 @@ class QListWidgetItem;
//SFLPhone
class AccountItemWidget;
-///@class AccountView List widgets displaying accounts
+///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 07e044c02c..f3e1f6c02c 100755
--- a/kde/src/ActionSetAccountFirst.h
+++ b/kde/src/ActionSetAccountFirst.h
@@ -26,7 +26,7 @@
#include "lib/Account.h"
-///@class ActionSetAccountFirst Set an account to be the first
+///ActionSetAccountFirst Set an account to be the first
class ActionSetAccountFirst : public QAction
{
Q_OBJECT
diff --git a/kde/src/CallView.cpp b/kde/src/CallView.cpp
index ec0e988822..d43e6792ad 100644
--- a/kde/src/CallView.cpp
+++ b/kde/src/CallView.cpp
@@ -48,7 +48,7 @@
#include "klib/ConfigurationSkeleton.h"
#include "SFLPhoneAccessibility.h"
-///@class CallTreeItemDelegate Delegates for CallTreeItem
+///CallTreeItemDelegate: Delegates for CallTreeItem
class CallTreeItemDelegate : public QStyledItemDelegate
{
public:
diff --git a/kde/src/CallView.h b/kde/src/CallView.h
index 6da609f112..ebde9c1973 100644
--- a/kde/src/CallView.h
+++ b/kde/src/CallView.h
@@ -40,7 +40,7 @@ class CallTreeItemDelegate;
//Typedef
typedef CallModel<CallTreeItem*,QTreeWidgetItem*> TreeWidgetCallModel;
-///@class CallViewOverlay Display overlay on top of the call tree
+///CallViewOverlay: Display overlay on top of the call tree
class CallViewOverlay : public QWidget {
Q_OBJECT
@@ -70,7 +70,7 @@ private slots:
void changeVisibility();
};
-///@class CallView Central tree widget managing active calls
+///CallView: Central tree widget managing active calls
class CallView : public QTreeWidget {
Q_OBJECT
friend class CallTreeItemDelegate;
diff --git a/kde/src/Codec.h b/kde/src/Codec.h
index d577f63914..ef1bf2b54e 100755
--- a/kde/src/Codec.h
+++ b/kde/src/Codec.h
@@ -26,7 +26,7 @@
//Qt
class QString;
-///@class Codec A SIP codec
+///Codec: A SIP codec
class Codec : public QObject
{
Q_OBJECT
diff --git a/kde/src/SFLPhoneAccessibility.cpp b/kde/src/SFLPhoneAccessibility.cpp
index 033ff986b0..ce81b89c4d 100644
--- a/kde/src/SFLPhoneAccessibility.cpp
+++ b/kde/src/SFLPhoneAccessibility.cpp
@@ -24,8 +24,9 @@
#include <KLocale>
#include "SFLPhone.h"
-SFLPhoneAccessibility* SFLPhoneAccessibility::m_pInstance=0;
+SFLPhoneAccessibility* SFLPhoneAccessibility::m_pInstance=nullptr;
+///Constructor
SFLPhoneAccessibility::SFLPhoneAccessibility() : QObject(0),QList<KAction*>()
{
KAction* action = new KAction(0);
@@ -45,6 +46,7 @@ SFLPhoneAccessibility::SFLPhoneAccessibility() : QObject(0),QList<KAction*>()
connect(action,SIGNAL(triggered(bool)),this,SLOT(currentCallDetails()));
}
+///Signleton
SFLPhoneAccessibility* SFLPhoneAccessibility::getInstance()
{
if (not m_pInstance) {
@@ -53,6 +55,7 @@ SFLPhoneAccessibility* SFLPhoneAccessibility::getInstance()
return m_pInstance;
}
+///Use the speech daemon to read details about the current calls
void SFLPhoneAccessibility::listCall()
{
if (SFLPhone::model()->getCallList().size()>0) {
@@ -66,6 +69,7 @@ void SFLPhoneAccessibility::listCall()
}
}
+///Convert number to digit so the speech daemon say "one two three" instead of "one hundred and twenty three"
QString SFLPhoneAccessibility::numberToDigit(QString number)
{
QString toReturn;
@@ -78,6 +82,7 @@ QString SFLPhoneAccessibility::numberToDigit(QString number)
return toReturn;
}
+///Use the speech daemon to read the current call details
void SFLPhoneAccessibility::currentCallDetails()
{
foreach (Call* call,SFLPhone::model()->getCallList()) {
@@ -99,6 +104,7 @@ void SFLPhoneAccessibility::currentCallDetails()
}
}
+///Helper function is make code shorter
void SFLPhoneAccessibility::say(QString message)
{
KSpeechInterfaceSingleton::getInstance()->say(message, KSpeech::soPlainText);
diff --git a/kde/src/SFLPhoneAccessibility.h b/kde/src/SFLPhoneAccessibility.h
index c9442dbaef..411bde9a7d 100644
--- a/kde/src/SFLPhoneAccessibility.h
+++ b/kde/src/SFLPhoneAccessibility.h
@@ -23,6 +23,7 @@
#include <QtCore/QList>
#include <KAction>
+///SFLPhoneAccessibility: Functions to improve accessibility for disabled peoples
class SFLPhoneAccessibility : public QObject, public QList<KAction*>
{
Q_OBJECT
diff --git a/kde/src/SFLPhoneView.cpp b/kde/src/SFLPhoneView.cpp
index a826334eb2..964497ce38 100755
--- a/kde/src/SFLPhoneView.cpp
+++ b/kde/src/SFLPhoneView.cpp
@@ -686,22 +686,6 @@ void SFLPhoneView::contextMenuEvent(QContextMenuEvent *event)
menu.exec(event->globalPos());
}
-///
-void SFLPhoneView::editBeforeCall()
-{
- QString name;
- QString number;
-
- bool ok;
- QString newNumber = QInputDialog::getText(this, i18n("Edit before call"), QString(), QLineEdit::Normal, number, &ok);
- if(ok) {
- Call* call = SFLPhone::model()->addDialingCall(name);
- call->appendText(newNumber);
- //callView->selectItem(addCallToCallList(call));
- action(call, CALL_ACTION_ACCEPT);
- }
-}
-
///Pick the default account and load it
void SFLPhoneView::setAccountFirst(Account * account)
{
@@ -729,7 +713,7 @@ void SFLPhoneView::configureSflPhone()
configDialog->show();
}
-///Show the accoutn creation wizard
+///Show the account creation wizard
void SFLPhoneView::accountCreationWizard()
{
if (!wizard) {
diff --git a/kde/src/SFLPhoneView.h b/kde/src/SFLPhoneView.h
index e611fa2552..82ba5cfa52 100755
--- a/kde/src/SFLPhoneView.h
+++ b/kde/src/SFLPhoneView.h
@@ -142,14 +142,6 @@ private slots:
*/
void enter();
- /**
- * Displays a message window with editable text of the selected
- * phone number in history or address book.
- * Once the user accepts, place a call with the chosen phone number.
- * Keeps the peer name of the contact or past call.
- */
- void editBeforeCall();
-
/**
* Updates the history's search bar's display according to the current
* text searched.
diff --git a/kde/src/SFLPhoneapplication.h b/kde/src/SFLPhoneapplication.h
index 129a3b8e5e..b7bd24697c 100755
--- a/kde/src/SFLPhoneapplication.h
+++ b/kde/src/SFLPhoneapplication.h
@@ -28,7 +28,7 @@
//SFLPhone
class SFLPhone;
-///@class SFLPhoneApplication Main application
+///SFLPhoneApplication: Main application
class SFLPhoneApplication : public KApplication
{
Q_OBJECT
diff --git a/kde/src/conf/ConfigAccountList.h b/kde/src/conf/ConfigAccountList.h
index d1ac987410..74a832329a 100644
--- a/kde/src/conf/ConfigAccountList.h
+++ b/kde/src/conf/ConfigAccountList.h
@@ -24,7 +24,7 @@
#include "../lib/AccountList.h"
#include "../AccountView.h"
-///@class ConfigAccountList Account list model
+///ConfigAccountList: Account list model
class ConfigAccountList : public QObject {
Q_OBJECT
public:
diff --git a/kde/src/conf/dlgaccessibility.h b/kde/src/conf/dlgaccessibility.h
index 8d3c3ea318..0b4810d3f3 100644
--- a/kde/src/conf/dlgaccessibility.h
+++ b/kde/src/conf/dlgaccessibility.h
@@ -24,7 +24,7 @@
#include "ui_dlgaccessibility.h"
-///@class DlgAccessibility Display option for the visually impaired
+///DlgAccessibility: Display option for the visually impaired
class DlgAccessibility : public QWidget, public Ui_DlgAccessibility
{
Q_OBJECT
diff --git a/kde/src/conf/dlgaccounts.h b/kde/src/conf/dlgaccounts.h
index 4aa58039d0..574e6d451c 100755
--- a/kde/src/conf/dlgaccounts.h
+++ b/kde/src/conf/dlgaccounts.h
@@ -47,7 +47,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
+///Private_AddCodecDialog: Little dialog to add codec to the list
class Private_AddCodecDialog : public KDialog {
Q_OBJECT
public:
@@ -63,7 +63,7 @@ class Private_AddCodecDialog : public KDialog {
void addCodec(QString alias);
};
-///@class RingToneListItem Ringtone list widget
+///RingToneListItem: Ringtone list widget
class RingToneListItem : public QWidget
{
Q_OBJECT
diff --git a/kde/src/conf/dlgvideo.h b/kde/src/conf/dlgvideo.h
index df463d62cb..8a30dc1372 100644
--- a/kde/src/conf/dlgvideo.h
+++ b/kde/src/conf/dlgvideo.h
@@ -26,7 +26,7 @@
class VideoDevice;
-///@class DlgVideo video preferences for sflphone
+///DlgVideo: video preferences for sflphone
class DlgVideo : public QWidget, public Ui_DlgVideoBase
{
Q_OBJECT
diff --git a/kde/src/klib/AkonadiBackend.cpp b/kde/src/klib/AkonadiBackend.cpp
index 32d6e4f159..5014f3907b 100644
--- a/kde/src/klib/AkonadiBackend.cpp
+++ b/kde/src/klib/AkonadiBackend.cpp
@@ -96,7 +96,7 @@ ContactBackend* AkonadiBackend::getInstance()
return m_pInstance;
}
-///Find contact using a phone number,
+///Find contact using a phone number
///@param resolveDNS check if the DNS is used by an account, then assume contact with that phone number / extension is the same as the caller
Contact* AkonadiBackend::getContactByPhone(const QString& phoneNumber,bool resolveDNS)
{
diff --git a/kde/src/klib/AkonadiBackend.h b/kde/src/klib/AkonadiBackend.h
index b6ca9cf4ba..1ddebe16ec 100644
--- a/kde/src/klib/AkonadiBackend.h
+++ b/kde/src/klib/AkonadiBackend.h
@@ -44,7 +44,7 @@ namespace Akonadi {
//SFLPhone
class Contact;
-///@class AkonadiBackend Implement a backend for Akonadi
+///AkonadiBackend: Implement a backend for Akonadi
class LIB_EXPORT AkonadiBackend : public ContactBackend {
Q_OBJECT
public:
diff --git a/kde/src/klib/HelperFunctions.h b/kde/src/klib/HelperFunctions.h
index 9eeef93c7c..8f6f99f081 100644
--- a/kde/src/klib/HelperFunctions.h
+++ b/kde/src/klib/HelperFunctions.h
@@ -33,7 +33,7 @@
//Typedef
typedef QHash<QString,QHash<QString,QVariant> > ContactHash;
-///@class HelperFunctions little visitor not belonging to libqtsflphone
+///HelperFunctions: little visitor not belonging to libqtsflphone
///Ramdom mix of dynamic property and transtypping
class LIB_EXPORT HelperFunctions {
public:
diff --git a/kde/src/klib/SortableDockCommon.h b/kde/src/klib/SortableDockCommon.h
index 32e2e75bf7..a86af26ec7 100644
--- a/kde/src/klib/SortableDockCommon.h
+++ b/kde/src/klib/SortableDockCommon.h
@@ -56,7 +56,7 @@ enum HistorySortingMode {
Length = 3,
};
-///@class SortableDockCommon Common code for filtering
+///SortableDockCommon: Common code for filtering
template <typename CallWidget = QWidget*, typename Index = QModelIndex*>
class LIB_EXPORT SortableDockCommon {
public:
@@ -111,7 +111,7 @@ class LIB_EXPORT SortableDockCommon {
};
-///@class StaticEventHandler "cron jobs" for static member;
+///StaticEventHandler: "cron jobs" for static member;
class LIB_EXPORT StaticEventHandler : public QObject
{
Q_OBJECT
diff --git a/kde/src/klib/dataengine/sflphonEngine.h b/kde/src/klib/dataengine/sflphonEngine.h
index bf510b6c6d..e13f42f696 100644
--- a/kde/src/klib/dataengine/sflphonEngine.h
+++ b/kde/src/klib/dataengine/sflphonEngine.h
@@ -41,6 +41,7 @@ typedef QHash<QString,QVariant> HashStringString;
typedef QHash<QString,QHash<QString,QVariant> > ContactHash ;
class Call;
+///SFLPhoneEngine: SFLPhone KDE plasma dataengine
class SFLPhoneEngine : public Plasma::DataEngine,public SortableDockCommon<>
{
Q_OBJECT
diff --git a/kde/src/klib/dataengine/sflphoneService.h b/kde/src/klib/dataengine/sflphoneService.h
index b5004f863d..bc65bd7195 100644
--- a/kde/src/klib/dataengine/sflphoneService.h
+++ b/kde/src/klib/dataengine/sflphoneService.h
@@ -33,7 +33,7 @@ using namespace Plasma;
class Account;
-///@class SFLPhoneService RPC between the plasmoid and the library
+///SFLPhoneService: RPC between the plasmoid and the library
class SFLPhoneService : public Plasma::Service
{
Q_OBJECT
@@ -46,7 +46,7 @@ private:
SFLPhoneEngine *m_engine;
};
-///@class CallJob Call using and account and a number
+///CallJob: Call using and account and a number
class CallJob : public Plasma::ServiceJob
{
Q_OBJECT
@@ -60,7 +60,7 @@ private:
QString m_Number ;
};
-///@class DTMFJob Play a sound when called
+///DTMFJob: Play a sound when called
class DTMFJob : public Plasma::ServiceJob
{
Q_OBJECT
@@ -72,7 +72,7 @@ private:
QString m_mStr;
};
-///@class HangUpJob Hang up a call using an id
+///HangUpJob: Hang up a call using an id
class HangUpJob : public Plasma::ServiceJob
{
Q_OBJECT
@@ -84,7 +84,7 @@ private:
QString m_CallId;
};
-///@class TransferJob Transfer a call
+///TransferJob: Transfer a call
class TransferJob : public Plasma::ServiceJob
{
Q_OBJECT
@@ -97,7 +97,7 @@ private:
QString m_transferNumber;
};
-///@class HoldJob Put or remove a call from hold mode
+///HoldJob: Put or remove a call from hold mode
class HoldJob : public Plasma::ServiceJob
{
Q_OBJECT
@@ -109,7 +109,7 @@ private:
QString m_CallId;
};
-///@class RecordJob Record a call
+///RecordJob: Record a call
class RecordJob : public Plasma::ServiceJob
{
Q_OBJECT
diff --git a/kde/src/lib/Account.h b/kde/src/lib/Account.h
index 408e0819bc..acd98458cd 100644
--- a/kde/src/lib/Account.h
+++ b/kde/src/lib/Account.h
@@ -33,7 +33,7 @@ class QString;
const QString& account_state_name(const QString& s);
-///@class Account a daemon account (SIP or AIX)
+///Account: a daemon account (SIP or AIX)
class LIB_EXPORT Account : public QObject {
Q_OBJECT
diff --git a/kde/src/lib/AccountList.cpp b/kde/src/lib/AccountList.cpp
index 833b0244b5..33ac61aff7 100644
--- a/kde/src/lib/AccountList.cpp
+++ b/kde/src/lib/AccountList.cpp
@@ -219,13 +219,13 @@ void AccountList::removeAccount(Account* account)
* *
****************************************************************************/
-///Get the accoutn from its index
+///Get the account from its index
const Account* AccountList::operator[] (int i) const
{
return (*m_pAccounts)[i];
}
-///Get the accoutn from its index
+///Get the account from its index
Account* AccountList::operator[] (int i)
{
return (*m_pAccounts)[i];
diff --git a/kde/src/lib/AccountList.h b/kde/src/lib/AccountList.h
index e0c5aac0a2..16bca59d9b 100644
--- a/kde/src/lib/AccountList.h
+++ b/kde/src/lib/AccountList.h
@@ -27,7 +27,7 @@
#include "Account.h"
#include "typedefs.h"
-///@class AccountList List of all daemon accounts
+///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 0cca16f49e..a30e8b5fa4 100644
--- a/kde/src/lib/CallModel.h
+++ b/kde/src/lib/CallModel.h
@@ -44,7 +44,7 @@ class HistoryModel;
typedef QMap<QString, Call*> CallMap;
typedef QList<Call*> CallList;
-///@class CallModelBase Base class for the central model/frontend
+///CallModelBase: Base class for the central model/frontend
///This class need to exist because template classes can't have signals and
///slots because Qt MOC generator can't guess the type at precompilation
class LIB_EXPORT CallModelBase : public QObject
@@ -103,7 +103,7 @@ signals:
* Using QAbstractModel resulted in a failure. Managing all corner case bloated the code to the point of no
* return. This frontend may not be cleaner from a design point of view, but it is from a code point of view
*/
-///@class CallModel Central model/frontend to deal with sflphoned
+///CallModel: Central model/frontend to deal with sflphoned
template <typename CallWidget = QWidget*, typename Index = QModelIndex*>
class LIB_EXPORT CallModel : public CallModelBase {
public:
diff --git a/kde/src/lib/Contact.h b/kde/src/lib/Contact.h
index bad7467bd0..83c119b83b 100644
--- a/kde/src/lib/Contact.h
+++ b/kde/src/lib/Contact.h
@@ -38,7 +38,7 @@ namespace KABC {
#include "typedefs.h"
-///@class Contact Abstract version of a contact
+///Contact: Abstract version of a contact
class LIB_EXPORT Contact : public QObject{
Q_OBJECT
public:
diff --git a/kde/src/lib/ContactBackend.h b/kde/src/lib/ContactBackend.h
index d46a281bf0..c62c3fb990 100644
--- a/kde/src/lib/ContactBackend.h
+++ b/kde/src/lib/ContactBackend.h
@@ -35,7 +35,7 @@ class Contact;
//Typedef
typedef QList<Contact*> ContactList;
-///@class ContactBackend Allow different way to handle contact without poluting the library
+///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/lib/HistoryModel.cpp b/kde/src/lib/HistoryModel.cpp
index cdfc4bfc63..05be16fcb0 100644
--- a/kde/src/lib/HistoryModel.cpp
+++ b/kde/src/lib/HistoryModel.cpp
@@ -27,6 +27,7 @@
* Private classes *
* *
****************************************************************************/
+///SortableCallSource: helper class to make sorting possible
class SortableCallSource {
public:
SortableCallSource(Call* call=0) : count(0),callInfo(call) {}
diff --git a/kde/src/lib/HistoryModel.h b/kde/src/lib/HistoryModel.h
index f26a0c6c22..8d3cd7be1f 100644
--- a/kde/src/lib/HistoryModel.h
+++ b/kde/src/lib/HistoryModel.h
@@ -33,7 +33,7 @@ class Call;
typedef QMap<QString, Call*> CallMap;
typedef QList<Call*> CallList;
-///@class HistoryModel History call manager
+///HistoryModel: History call manager
class LIB_EXPORT HistoryModel : public QObject {
Q_OBJECT
public:
diff --git a/kde/src/lib/VideoCodec.h b/kde/src/lib/VideoCodec.h
index 792a1eb992..c693006af4 100644
--- a/kde/src/lib/VideoCodec.h
+++ b/kde/src/lib/VideoCodec.h
@@ -32,7 +32,7 @@ class Account;
class VideoCodec;
typedef QHash<QString,VideoCodec*> CodecHash;
-///@class VideoCodec Codecs used for video calls
+///VideoCodec: Codecs used for video calls
class LIB_EXPORT VideoCodec {
public:
diff --git a/kde/src/lib/VideoDevice.h b/kde/src/lib/VideoDevice.h
index 768990f3c4..18322baf55 100644
--- a/kde/src/lib/VideoDevice.h
+++ b/kde/src/lib/VideoDevice.h
@@ -51,7 +51,7 @@ struct LIB_EXPORT Resolution {
}
};
-///@class VideoDevice V4L devices used to record video for video call
+///VideoDevice: V4L devices used to record video for video call
class LIB_EXPORT VideoDevice {
public:
//Singleton
diff --git a/kde/src/lib/VideoModel.h b/kde/src/lib/VideoModel.h
index 1b6b647386..3cb03a25ed 100644
--- a/kde/src/lib/VideoModel.h
+++ b/kde/src/lib/VideoModel.h
@@ -29,7 +29,7 @@ class QTimer;
//SFLPhone
#include "VideoDevice.h"
-///@class VideoModel Video event dispatcher
+///VideoModel: Video event dispatcher
class LIB_EXPORT VideoModel : public QObject {
Q_OBJECT
public:
diff --git a/kde/src/widgets/AccountItemWidget.h b/kde/src/widgets/AccountItemWidget.h
index 3c76f74ddd..5bbc583a21 100755
--- a/kde/src/widgets/AccountItemWidget.h
+++ b/kde/src/widgets/AccountItemWidget.h
@@ -30,7 +30,7 @@ class QCheckBox;
class QLabel;
-///@class AccountItemWidget Widget for the config dialog account list
+///AccountItemWidget: Widget for the config dialog account list
class AccountItemWidget : public QWidget
{
Q_OBJECT
diff --git a/kde/src/widgets/BookmarkDock.cpp b/kde/src/widgets/BookmarkDock.cpp
index de96add744..61774fee17 100644
--- a/kde/src/widgets/BookmarkDock.cpp
+++ b/kde/src/widgets/BookmarkDock.cpp
@@ -44,7 +44,7 @@
#include "klib/HelperFunctions.h"
#include "lib/HistoryModel.h"
-///@class QNumericTreeWidgetItem : Tree widget with different sorting criterias
+///QNumericTreeWidgetItem : Tree widget with different sorting criterias
class QNumericTreeWidgetItem : public QTreeWidgetItem {
public:
QNumericTreeWidgetItem(QTreeWidget* parent):QTreeWidgetItem(parent),widget(0),weight(-1){}
diff --git a/kde/src/widgets/BookmarkDock.h b/kde/src/widgets/BookmarkDock.h
index 30f58298d2..d9ecb2e1cc 100644
--- a/kde/src/widgets/BookmarkDock.h
+++ b/kde/src/widgets/BookmarkDock.h
@@ -39,7 +39,7 @@ class CategorizedTreeWidget;
//Typedef
typedef QList<HistoryTreeItem*> BookmarkList;
-///@class BookmarkDock Dock for managing favorite contacts
+///BookmarkDock: Dock for managing favorite contacts
class BookmarkDock : public QDockWidget {
Q_OBJECT
public:
diff --git a/kde/src/widgets/CallTreeItem.h b/kde/src/widgets/CallTreeItem.h
index 43cc1041dd..5c7669331d 100644
--- a/kde/src/widgets/CallTreeItem.h
+++ b/kde/src/widgets/CallTreeItem.h
@@ -41,7 +41,7 @@ class Call;
class TranslucentButtons;
class Contact;
-///@class CallTreeItem Widget for the central call treeview
+///CallTreeItem: Widget for the central call treeview
class CallTreeItem : public QWidget
{
Q_OBJECT
diff --git a/kde/src/widgets/CategorizedTreeWidget.h b/kde/src/widgets/CategorizedTreeWidget.h
index 0652281e64..f486bd28fe 100644
--- a/kde/src/widgets/CategorizedTreeWidget.h
+++ b/kde/src/widgets/CategorizedTreeWidget.h
@@ -28,6 +28,7 @@ class KConfigGroup;
class KateColorTreeItem;
class QTreeWidgetItem;
+///CategorizedTreeWidget: A better looking widget than the plain QListWidget
class CategorizedTreeWidget : public QTreeWidget
{
Q_OBJECT
diff --git a/kde/src/widgets/CategoryDrawer.h b/kde/src/widgets/CategoryDrawer.h
index 4973491f61..ae8e07b340 100644
--- a/kde/src/widgets/CategoryDrawer.h
+++ b/kde/src/widgets/CategoryDrawer.h
@@ -29,6 +29,7 @@ class QPainter;
class QModelIndex;
class QStyleOption;
+///CategoryDrawer: A better looking widget than the plain QListWidget
class CategoryDrawer : public KCategoryDrawerV2
{
public:
diff --git a/kde/src/widgets/ContactDock.cpp b/kde/src/widgets/ContactDock.cpp
index 8b2f677c76..32b33be495 100644
--- a/kde/src/widgets/ContactDock.cpp
+++ b/kde/src/widgets/ContactDock.cpp
@@ -54,7 +54,7 @@
#define CURRENT_SORTING_MODE m_pSortByCBB->currentIndex()
-///@class QNumericTreeWidgetItem_hist TreeWidget using different sorting criterias
+///QNumericTreeWidgetItem_hist: TreeWidget using different sorting criterias
class QNumericTreeWidgetItem_hist : public QTreeWidgetItem {
public:
QNumericTreeWidgetItem_hist(QTreeWidget* parent):QTreeWidgetItem(parent),widget(0),weight(-1){}
diff --git a/kde/src/widgets/ContactDock.h b/kde/src/widgets/ContactDock.h
index 902edbe9d0..38f5b64f5a 100644
--- a/kde/src/widgets/ContactDock.h
+++ b/kde/src/widgets/ContactDock.h
@@ -58,7 +58,7 @@ class ContactItemWidget;
class StaticEventHandler;
class Contact;
-///@class ContactDock Dock to access contacts
+///ContactDock: Dock to access contacts
class ContactDock : public QDockWidget, public SortableDockCommon<CallTreeItem*,QTreeWidgetItem*>
{
Q_OBJECT
@@ -88,7 +88,7 @@ private slots:
void reloadHistoryConst ( );
};
-///@class ContactTree tree view with additinal drag and drop
+///ContactTree: tree view with additinal drag and drop
class ContactTree : public CategorizedTreeWidget {
Q_OBJECT
public:
@@ -97,7 +97,7 @@ public:
bool dropMimeData(QTreeWidgetItem *parent, int index, const QMimeData *data, Qt::DropAction action);
};
-///@class KeyPressEaterC keygrabber
+///KeyPressEaterC: keygrabber
class KeyPressEaterC : public QObject
{
Q_OBJECT
diff --git a/kde/src/widgets/ContactItemWidget.h b/kde/src/widgets/ContactItemWidget.h
index dfa356fe84..3e6c8aed47 100644
--- a/kde/src/widgets/ContactItemWidget.h
+++ b/kde/src/widgets/ContactItemWidget.h
@@ -42,7 +42,7 @@ namespace KABC {
class Contact;
class TranslucentButtons;
-///@class ContactItemWidget Item for the contact tree
+///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 5dd1784a98..576f341ddd 100755
--- a/kde/src/widgets/Dialpad.h
+++ b/kde/src/widgets/Dialpad.h
@@ -27,7 +27,7 @@
//Qt
class QGridLayout;
-///@class DialpadButton the 12 button of the dialpad
+///DialpadButton: the 12 button of the dialpad
class DialpadButton : public QPushButton
{
Q_OBJECT
@@ -44,7 +44,7 @@ signals:
};
-///@class Dialpad A widget that representing a phone dialpad with associated numbers and letters
+///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.cpp b/kde/src/widgets/HistoryDock.cpp
index c6e989f976..44690af501 100644
--- a/kde/src/widgets/HistoryDock.cpp
+++ b/kde/src/widgets/HistoryDock.cpp
@@ -52,7 +52,7 @@
#define CURRENT_SORTING_MODE m_pSortByCBB->currentIndex()
-///@class QNumericTreeWidgetItem Qt lack official functional sorting algo, so this hack around it
+///QNumericTreeWidgetItem: Qt lack official functional sorting algo, so this hack around it
class QNumericTreeWidgetItem : public QTreeWidgetItem {
public:
QNumericTreeWidgetItem(QTreeWidget* parent=0):QTreeWidgetItem(parent),widget(0),weight(-1){}
diff --git a/kde/src/widgets/HistoryDock.h b/kde/src/widgets/HistoryDock.h
index 1b0755caab..c0aade1564 100644
--- a/kde/src/widgets/HistoryDock.h
+++ b/kde/src/widgets/HistoryDock.h
@@ -52,7 +52,7 @@ class QNumericTreeWidgetItem;
typedef QList<HistoryTreeItem*> HistoryList;
typedef QHash<QString,QNumericTreeWidgetItem*> GroupHash;
-///@class HistoryDock Dock to see the previous SFLPhone calls
+///HistoryDock: Dock to see the previous SFLPhone calls
class HistoryDock : public QDockWidget, public SortableDockCommon<CallTreeItem*,QTreeWidgetItem*> {
Q_OBJECT
@@ -99,7 +99,7 @@ private slots:
};
-///@class HistoryTree Simple tree view with additional keybpard filter
+///HistoryTree: Simple tree view with additional keybpard filter
class HistoryTree : public CategorizedTreeWidget {
Q_OBJECT
public:
@@ -108,7 +108,7 @@ public:
bool dropMimeData(QTreeWidgetItem *parent, int index, const QMimeData *data, Qt::DropAction action);
};
-///@class KeyPressEater Intercept each keypress to manage it globally
+///KeyPressEater: Intercept each keypress to manage it globally
class KeyPressEater : public QObject
{
Q_OBJECT
diff --git a/kde/src/widgets/HistoryTreeItem.cpp b/kde/src/widgets/HistoryTreeItem.cpp
index a0471e4415..440b29d72c 100644
--- a/kde/src/widgets/HistoryTreeItem.cpp
+++ b/kde/src/widgets/HistoryTreeItem.cpp
@@ -60,6 +60,7 @@
const char * HistoryTreeItem::callStateIcons[12] = {ICON_INCOMING, ICON_RINGING, ICON_CURRENT, ICON_DIALING, ICON_HOLD, ICON_FAILURE, ICON_BUSY, ICON_TRANSFER, ICON_TRANSF_HOLD, "", "", ICON_CONFERENCE};
+///PlayerWidget: A small widget to play call recording
class PlayerWidget : public QWidget {
public:
PlayerWidget(QWidget* parent = 0) : QWidget(parent) {}
diff --git a/kde/src/widgets/HistoryTreeItem.h b/kde/src/widgets/HistoryTreeItem.h
index 670301dafd..4970adea76 100644
--- a/kde/src/widgets/HistoryTreeItem.h
+++ b/kde/src/widgets/HistoryTreeItem.h
@@ -49,7 +49,7 @@ class QMimeData;
//KDE
class KAction;
-///@class HistoryTreeItem Items for the history dock
+///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 bfad9dae09..9f0da19c27 100755
--- a/kde/src/widgets/SFLPhoneTray.h
+++ b/kde/src/widgets/SFLPhoneTray.h
@@ -31,7 +31,7 @@ class KAction;
class QMenu;
class QIcon;
-///@class SFLPhoneTray The old system try, should be totally replaced by a plasmoid some day
+///SFLPhoneTray: The old system try, should be totally replaced by a plasmoid some day
class SFLPhoneTray : public KSystemTrayIcon
{
Q_OBJECT
diff --git a/kde/src/widgets/TranslucentButtons.h b/kde/src/widgets/TranslucentButtons.h
index 8176c54452..7051ff5490 100644
--- a/kde/src/widgets/TranslucentButtons.h
+++ b/kde/src/widgets/TranslucentButtons.h
@@ -7,7 +7,7 @@ class QTimer;
class QMimeData;
class QImage;
-///@class TranslucentButtons Fancy buttons for the call widget
+///TranslucentButtons: Fancy buttons for the call widget
class TranslucentButtons : public QPushButton
{
Q_OBJECT
diff --git a/kde/src/widgets/VideoWidget.h b/kde/src/widgets/VideoWidget.h
index 1a06f6fd80..7c9e116005 100644
--- a/kde/src/widgets/VideoWidget.h
+++ b/kde/src/widgets/VideoWidget.h
@@ -24,6 +24,7 @@
#include "../lib/VideoModel.h"
+///VideoWidget: A widget to display video from a framebuffer
class VideoWidget : public QWidget {
Q_OBJECT
public:
--
GitLab