summaryrefslogtreecommitdiffstats
path: root/src/libs/kdtools
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-09-02 23:53:35 +0200
committerArttu Tarkiainen <arttu.tarkiainen@qt.io>2020-09-16 13:04:04 +0300
commite1dc7d5340725f04a8e85c7581d4be2387fb423e (patch)
tree12f4442a80a215cf9388d2180a3aa044e4c60f3f /src/libs/kdtools
parent913c7ea16f961a8f5688734cd12d00fbeaa5d48c (diff)
Doc: Fix documentation warnings
These changes fix many of the documentation warnings when building with a recent version of (Clang-integrated) QDoc. Change-Id: I5714635a25707cd7ab7bec209fa043a95f0b9832 Reviewed-by: Katja Marttila <katja.marttila@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src/libs/kdtools')
-rw-r--r--src/libs/kdtools/filedownloader.cpp40
-rw-r--r--src/libs/kdtools/filedownloaderfactory.cpp4
-rw-r--r--src/libs/kdtools/genericfactory.cpp12
-rw-r--r--src/libs/kdtools/task.cpp16
-rw-r--r--src/libs/kdtools/update.cpp2
-rw-r--r--src/libs/kdtools/updatefinder.cpp2
6 files changed, 38 insertions, 38 deletions
diff --git a/src/libs/kdtools/filedownloader.cpp b/src/libs/kdtools/filedownloader.cpp
index 91865fb5f..ca50e26d9 100644
--- a/src/libs/kdtools/filedownloader.cpp
+++ b/src/libs/kdtools/filedownloader.cpp
@@ -80,107 +80,107 @@ static double calcProgress(qint64 done, qint64 total)
*/
/*!
- \property FileDownloader::autoRemoveDownloadedFile
+ \property KDUpdater::FileDownloader::autoRemoveDownloadedFile
\brief Whether the downloaded file should be automatically removed after it
is downloaded and the class goes out of scope.
*/
/*!
- \property FileDownloader::url
+ \property KDUpdater::FileDownloader::url
\brief The URL to download files from.
*/
/*!
- \property FileDownloader::scheme
+ \property KDUpdater::FileDownloader::scheme
\brief The scheme to use for downloading files.
*/
/*!
- \fn FileDownloader::authenticatorChanged(const QAuthenticator &authenticator)
+ \fn KDUpdater::FileDownloader::authenticatorChanged(const QAuthenticator &authenticator)
This signal is emitted when the authenticator changes to \a authenticator.
*/
/*!
- \fn FileDownloader::canDownload() const = 0
+ \fn KDUpdater::FileDownloader::canDownload() const = 0
Returns \c true if the file exists and is readable.
*/
/*!
- \fn FileDownloader::clone(QObject *parent=0) const = 0
+ \fn KDUpdater::FileDownloader::clone(QObject *parent=0) const = 0
Clones the local file downloader and assigns it the parent \a parent.
*/
/*!
- \fn FileDownloader::downloadCanceled()
+ \fn KDUpdater::FileDownloader::downloadCanceled()
This signal is emitted if downloading a file is canceled.
*/
/*!
- \fn FileDownloader::downloadedFileName() const = 0
+ \fn KDUpdater::FileDownloader::downloadedFileName() const = 0
Returns the file name of the downloaded file.
*/
/*!
- \fn FileDownloader::downloadProgress(double progress)
+ \fn KDUpdater::FileDownloader::downloadProgress(double progress)
This signal is emitted with the current download \a progress.
*/
/*!
- \fn FileDownloader::downloadProgress(qint64 bytesReceived, qint64 bytesToReceive)
+ \fn KDUpdater::FileDownloader::downloadProgress(qint64 bytesReceived, qint64 bytesToReceive)
This signal is emitted with the download progress as the number of received bytes,
\a bytesReceived, and the total size of the file to download, \a bytesToReceive.
*/
/*!
- \fn FileDownloader::downloadSpeed(qint64 bytesPerSecond)
+ \fn KDUpdater::FileDownloader::downloadSpeed(qint64 bytesPerSecond)
This signal is emitted with the download speed in bytes per second as \a bytesPerSecond.
*/
/*!
- \fn FileDownloader::downloadStarted()
+ \fn KDUpdater::FileDownloader::downloadStarted()
This signal is emitted when downloading a file starts.
*/
/*!
- \fn FileDownloader::downloadStatus(const QString &status)
+ \fn KDUpdater::FileDownloader::downloadStatus(const QString &status)
This signal is emitted with textual representation of the current download \a status in the
following format: "100 MiB of 150 MiB - (DAYS) (HOURS) (MINUTES) (SECONDS) remaining".
*/
/*!
- \fn FileDownloader::downloadCompleted()
+ \fn KDUpdater::FileDownloader::downloadCompleted()
This signal is emitted when downloading a file ends.
*/
/*!
- \fn FileDownloader::downloadAborted(const QString &errorMessage)
+ \fn KDUpdater::FileDownloader::downloadAborted(const QString &errorMessage)
This signal is emitted when downloading a file is aborted with \a errorMessage.
*/
/*!
- \fn FileDownloader::estimatedDownloadTime(int seconds)
+ \fn KDUpdater::FileDownloader::estimatedDownloadTime(int seconds)
This signal is emitted with the estimated download time in \a seconds.
*/
/*!
- \fn FileDownloader::isDownloaded() const = 0
+ \fn KDUpdater::FileDownloader::isDownloaded() const = 0
Returns \c true if the file is downloaded.
*/
/*!
- \fn FileDownloader::onError() = 0
+ \fn KDUpdater::FileDownloader::onError() = 0
Closes the destination file if an error occurs during copying and stops
the download speed timer.
*/
/*!
- \fn FileDownloader::onSuccess() = 0
+ \fn KDUpdater::FileDownloader::onSuccess() = 0
Closes the destination file after it has been successfully copied and stops
the download speed timer.
*/
/*!
- \fn FileDownloader::setDownloadedFileName(const QString &name) = 0
+ \fn KDUpdater::FileDownloader::setDownloadedFileName(const QString &name) = 0
Sets the file name of the downloaded file to \a name.
*/
diff --git a/src/libs/kdtools/filedownloaderfactory.cpp b/src/libs/kdtools/filedownloaderfactory.cpp
index 098c03c6d..fb6067f18 100644
--- a/src/libs/kdtools/filedownloaderfactory.cpp
+++ b/src/libs/kdtools/filedownloaderfactory.cpp
@@ -181,13 +181,13 @@ FileDownloader *FileDownloaderFactory::create(const QString &scheme, QObject *pa
*/
/*!
- \fn FileDownloaderProxyFactory::~FileDownloaderProxyFactory()
+ \fn KDUpdater::FileDownloaderProxyFactory::~FileDownloaderProxyFactory()
Destroys the file downloader proxy factory.
*/
/*!
- \fn FileDownloaderProxyFactory::clone() const
+ \fn KDUpdater::FileDownloaderProxyFactory::clone() const
Clones a file downloader proxy factory.
*/
diff --git a/src/libs/kdtools/genericfactory.cpp b/src/libs/kdtools/genericfactory.cpp
index 808719e7c..e45fb89ff 100644
--- a/src/libs/kdtools/genericfactory.cpp
+++ b/src/libs/kdtools/genericfactory.cpp
@@ -87,13 +87,13 @@
*/
/*!
- \fn GenericFactory::GenericFactory()
+ \fn template <typename BASE, typename IDENTIFIER, typename... ARGUMENTS> GenericFactory<BASE, IDENTIFIER, ARGUMENTS...>::GenericFactory()
Creates the generic factory.
*/
/*!
- \fn GenericFactory::~GenericFactory()
+ \fn template <typename BASE, typename IDENTIFIER, typename... ARGUMENTS> GenericFactory<BASE, IDENTIFIER, ARGUMENTS...>::~GenericFactory()
Destroys the generic factory.
*/
@@ -105,7 +105,7 @@
*/
/*!
- \fn void GenericFactory::registerProduct(const IDENTIFIER &id)
+ \fn template <typename BASE, typename IDENTIFIER, typename... ARGUMENTS> GenericFactory<BASE, IDENTIFIER, ARGUMENTS...>::registerProduct(const IDENTIFIER &id)
Registers a type DERIVED, identified by \a id in the factory. Any type with the same id gets
unregistered.
@@ -113,20 +113,20 @@
/*!
\overload
- \fn void GenericFactory::registerProduct(const IDENTIFIER &id, FactoryFunction func)
+ \fn template <typename BASE, typename IDENTIFIER, typename... ARGUMENTS> GenericFactory<BASE, IDENTIFIER, ARGUMENTS...>::registerProduct(const IDENTIFIER &id, FactoryFunction func)
Registers a function \a func that can create the type DERIVED, identified by \a id in the
factory. Any type with the same id gets unregistered.
*/
/*!
- \fn bool GenericFactory::containsProduct(const IDENTIFIER &id) const
+ \fn template <typename BASE, typename IDENTIFIER, typename... ARGUMENTS> GenericFactory<BASE, IDENTIFIER, ARGUMENTS...>::containsProduct(const IDENTIFIER &id) const
Returns \c true if the factory contains a type with the \a id; otherwise returns false.
*/
/*!
- \fn BASE *GenericFactory::create(const IDENTIFIER &id, ARGUMENTS... args) const
+ \fn template <typename BASE, typename IDENTIFIER, typename... ARGUMENTS> BASE *GenericFactory<BASE, IDENTIFIER, ARGUMENTS...>::create(const IDENTIFIER &id, ARGUMENTS... args) const
Creates and returns the type identified by \a id, but automatically upcasted to BASE. Ownership
of the type is transferred to the caller.
diff --git a/src/libs/kdtools/task.cpp b/src/libs/kdtools/task.cpp
index fbc3ed669..e63546bba 100644
--- a/src/libs/kdtools/task.cpp
+++ b/src/libs/kdtools/task.cpp
@@ -398,7 +398,7 @@ void Task::setAutoDelete(bool autoDelete)
*/
/*!
- \fn void Task::error(int code, const QString &errorText)
+ \fn void KDUpdater::Task::error(int code, const QString &errorText)
This signal is emitted to notify an error during the execution of this task.
@@ -407,45 +407,45 @@ void Task::setAutoDelete(bool autoDelete)
*/
/*!
- \fn void Task::progressValue(int percent)
+ \fn void KDUpdater::Task::progressValue(int percent)
This signal is emitted to report progress made by the task. The \a percent parameter gives
the progress made as a percentage.
*/
/*!
- \fn void Task::progressText(const QString &progressText)
+ \fn void KDUpdater::Task::progressText(const QString &progressText)
This signal is emitted to report the progress made by the task. The \a progressText parameter
represents the progress made in a human-readable form.
*/
/*!
- \fn void Task::started()
+ \fn void KDUpdater::Task::started()
This signal is emitted when the task has started.
*/
/*!
- \fn void Task::paused()
+ \fn void KDUpdater::Task::paused()
This signal is emitted when the task has paused.
*/
/*!
- \fn void Task::resumed()
+ \fn void KDUpdater::Task::resumed()
This signal is emitted when the task has resumed.
*/
/*!
- \fn void Task::stopped()
+ \fn void KDUpdater::Task::stopped()
This signal is emitted when the task has stopped (or canceled).
*/
/*!
- \fn void Task::finished()
+ \fn void KDUpdater::Task::finished()
This signal is emitted when the task has finished.
*/
diff --git a/src/libs/kdtools/update.cpp b/src/libs/kdtools/update.cpp
index 63c515276..5a77788ed 100644
--- a/src/libs/kdtools/update.cpp
+++ b/src/libs/kdtools/update.cpp
@@ -33,7 +33,7 @@ using namespace KDUpdater;
/*!
\inmodule kdupdater
\class KDUpdater::Update
- \brief Represents a single update
+ \brief Represents a single update.
The KDUpdater::Update class contains information about an update. It is created by KDUpdater::UpdateFinder
corresponding to the update.
diff --git a/src/libs/kdtools/updatefinder.cpp b/src/libs/kdtools/updatefinder.cpp
index 674ae578f..3adafe88e 100644
--- a/src/libs/kdtools/updatefinder.cpp
+++ b/src/libs/kdtools/updatefinder.cpp
@@ -552,7 +552,7 @@ void UpdateFinder::Private::slotDownloadDone()
/*!
\inmodule kdupdater
- This function compares two version strings \c v1 and \c v2 and returns
+ This function compares two version strings \a v1 and \a v2 and returns
-1, 0 or +1 based on the following rule
\list