summaryrefslogtreecommitdiffstats
path: root/src/libs/kdtools
diff options
context:
space:
mode:
authorkh1 <karsten.heimrich@digia.com>2014-10-07 15:05:08 +0200
committerKarsten Heimrich <karsten.heimrich@digia.com>2014-10-08 16:36:21 +0200
commit8ea9ccf39b47c57b432786b4b2fb135f56e53dde (patch)
tree82d0006dfd83b0ab6d8deb3385b83200164061dc /src/libs/kdtools
parent241141938dc07bb3915d48eebf2f56c13261edeb (diff)
Fix c++ documentation creation. Add, fix inline documentation.
Change-Id: Idd6805afbf5736eebf03c2d1ca6dae272c519634 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com> Reviewed-by: Niels Weber <niels.weber@digia.com>
Diffstat (limited to 'src/libs/kdtools')
-rw-r--r--src/libs/kdtools/kdupdaterapplication.cpp2
-rw-r--r--src/libs/kdtools/kdupdaterfiledownloader.cpp6
-rw-r--r--src/libs/kdtools/kdupdaterfiledownloaderfactory.cpp6
-rw-r--r--src/libs/kdtools/kdupdaterpackagesinfo.cpp4
-rw-r--r--src/libs/kdtools/kdupdatertask.cpp2
-rw-r--r--src/libs/kdtools/kdupdaterupdate.cpp2
-rw-r--r--src/libs/kdtools/kdupdaterupdatefinder.cpp4
-rw-r--r--src/libs/kdtools/kdupdaterupdateoperation.cpp6
-rw-r--r--src/libs/kdtools/kdupdaterupdateoperationfactory.cpp6
-rw-r--r--src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp6
10 files changed, 22 insertions, 22 deletions
diff --git a/src/libs/kdtools/kdupdaterapplication.cpp b/src/libs/kdtools/kdupdaterapplication.cpp
index 76290348c..ebc5caebb 100644
--- a/src/libs/kdtools/kdupdaterapplication.cpp
+++ b/src/libs/kdtools/kdupdaterapplication.cpp
@@ -75,7 +75,7 @@ medium-to-large scale software systems.
/*!
\class KDUpdater::Application kdupdaterapplication.h KDUpdaterApplication
- \ingroup kdupdater
+ \inmodule kdupdater
\brief This class represents an application that can be updated.
A KDUpdater application is an application that needs to interact with one or more update servers and
diff --git a/src/libs/kdtools/kdupdaterfiledownloader.cpp b/src/libs/kdtools/kdupdaterfiledownloader.cpp
index 96baf88b3..b535f22a6 100644
--- a/src/libs/kdtools/kdupdaterfiledownloader.cpp
+++ b/src/libs/kdtools/kdupdaterfiledownloader.cpp
@@ -71,11 +71,11 @@ static double calcProgress(qint64 done, qint64 total)
// -- KDUpdater::FileDownloader
/*!
- \internal
- \ingroup kdupdater
+ \inmodule kdupdater
\class KDUpdater::FileDownloader kdupdaterfiledownloader.h
+ \brief The FileDownloader class is the base class for file downloaders used in KDUpdater.
- Base class for file downloaders used in KDUpdater. File downloaders are used by
+ File downloaders are used by
the KDUpdater::Update class to download update files. Each subclass of FileDownloader
can download file from a specific category of sources (e.g. local, ftp, http etc).
diff --git a/src/libs/kdtools/kdupdaterfiledownloaderfactory.cpp b/src/libs/kdtools/kdupdaterfiledownloaderfactory.cpp
index cd6b552a5..5af9b00af 100644
--- a/src/libs/kdtools/kdupdaterfiledownloaderfactory.cpp
+++ b/src/libs/kdtools/kdupdaterfiledownloaderfactory.cpp
@@ -44,9 +44,10 @@
#include <QtNetwork/QSslSocket>
+using namespace KDUpdater;
+
/*!
- \internal
- \ingroup kdupdater
+ \inmodule kdupdater
\class KDUpdater::FileDownloaderFactory kdupdaterfiledownloaderfactory.h
\brief Factory for \ref KDUpdater::FileDownloader
@@ -57,7 +58,6 @@
be created and its reference can be fetched from the \ref instance() method.
*/
-using namespace KDUpdater;
FileDownloaderFactory& FileDownloaderFactory::instance()
{
diff --git a/src/libs/kdtools/kdupdaterpackagesinfo.cpp b/src/libs/kdtools/kdupdaterpackagesinfo.cpp
index 1e882e173..929618df2 100644
--- a/src/libs/kdtools/kdupdaterpackagesinfo.cpp
+++ b/src/libs/kdtools/kdupdaterpackagesinfo.cpp
@@ -50,7 +50,7 @@
using namespace KDUpdater;
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
\class KDUpdater::PackagesInfo kdupdaterpackagesinfo.h KDUpdaterPackagesInfo
\brief Provides access to information about packages installed on the application side.
@@ -528,7 +528,7 @@ void PackagesInfo::clearPackageInfoList()
*/
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
\struct KDUpdater::PackageInfo kdupdaterpackagesinfo.h KDUpdaterPackageInfo
\brief Describes a single installed package in the application.
diff --git a/src/libs/kdtools/kdupdatertask.cpp b/src/libs/kdtools/kdupdatertask.cpp
index 187bcdae7..469d1b2e0 100644
--- a/src/libs/kdtools/kdupdatertask.cpp
+++ b/src/libs/kdtools/kdupdatertask.cpp
@@ -44,7 +44,7 @@
using namespace KDUpdater;
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
\class KDUpdater::Task kdupdatertask.h KDUpdaterTask
\brief Base class for all task classes in KDUpdater
diff --git a/src/libs/kdtools/kdupdaterupdate.cpp b/src/libs/kdtools/kdupdaterupdate.cpp
index c6b0775e8..90f92dbd8 100644
--- a/src/libs/kdtools/kdupdaterupdate.cpp
+++ b/src/libs/kdtools/kdupdaterupdate.cpp
@@ -44,7 +44,7 @@
using namespace KDUpdater;
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
\class KDUpdater::Update kdupdaterupdate.h KDUpdaterUpdate
\brief Represents a single update
diff --git a/src/libs/kdtools/kdupdaterupdatefinder.cpp b/src/libs/kdtools/kdupdaterupdatefinder.cpp
index e53c47280..e7a6835f2 100644
--- a/src/libs/kdtools/kdupdaterupdatefinder.cpp
+++ b/src/libs/kdtools/kdupdaterupdatefinder.cpp
@@ -55,7 +55,7 @@
using namespace KDUpdater;
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
\class KDUpdater::UpdateFinder kdupdaterupdatefinder KDUpdaterUpdateFinder
\brief Finds updates applicable for a \ref KDUpdater::Application
@@ -531,7 +531,7 @@ void UpdateFinder::Private::slotDownloadDone()
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
This function compares two version strings \c v1 and \c v2 and returns
-1, 0 or +1 based on the following rule
diff --git a/src/libs/kdtools/kdupdaterupdateoperation.cpp b/src/libs/kdtools/kdupdaterupdateoperation.cpp
index 9ba165d4b..037aa536d 100644
--- a/src/libs/kdtools/kdupdaterupdateoperation.cpp
+++ b/src/libs/kdtools/kdupdaterupdateoperation.cpp
@@ -48,8 +48,10 @@
#include <QFileInfo>
#include <QTemporaryFile>
+using namespace KDUpdater;
+
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
\class KDUpdater::UpdateOperation kdupdaterupdateoperation.h KDUpdaterUpdateOperation
\brief Abstract base class for update operations.
@@ -76,8 +78,6 @@ static QString backupFileName(const QString &templateName)
return name;
}
-using namespace KDUpdater;
-
/*!
Constructor
*/
diff --git a/src/libs/kdtools/kdupdaterupdateoperationfactory.cpp b/src/libs/kdtools/kdupdaterupdateoperationfactory.cpp
index ed5c67a8b..9478d1751 100644
--- a/src/libs/kdtools/kdupdaterupdateoperationfactory.cpp
+++ b/src/libs/kdtools/kdupdaterupdateoperationfactory.cpp
@@ -44,8 +44,10 @@
#include <QHash>
+using namespace KDUpdater;
+
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
\class KDUpdater::UpdateOperationFactory kdupdaterupdateoperationfactory.h KDUpdaterUpdateOperationFactory
\brief Factory for \ref KDUpdater::UpdateOperation
@@ -63,8 +65,6 @@
T is constructed using its default constructor.
*/
-using namespace KDUpdater;
-
/*!
Returns the UpdateOperationFactory instance. The instance is created if needed.
*/
diff --git a/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp b/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp
index 140577d3c..ea54adcec 100644
--- a/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp
+++ b/src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp
@@ -49,9 +49,10 @@
#include <QFile>
#include <QTextStream>
+using namespace KDUpdater;
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
\class KDUpdater::UpdateSourcesInfo kdupdaterupdatesourcesinfo.h KDUpdaterUpdateSourcesInfo
\brief Provides access to information about the update sources set for the application.
@@ -102,7 +103,6 @@
* Changes made to the object could be saved back to the source file
*/
-using namespace KDUpdater;
struct UpdateSourceInfoPriorityHigherThan
{
@@ -405,7 +405,7 @@ void UpdateSourcesInfo::UpdateSourcesInfoData::addChildElement(QDomDocument &doc
}
/*!
- \ingroup kdupdater
+ \inmodule kdupdater
\struct KDUpdater::UpdateSourceInfo kdupdaterupdatesourcesinfo.h KDUpdaterUpdateSourcesInfo
\brief Describes a single update source