diff options
| author | Katja Marttila <katja.marttila@qt.io> | 2019-12-02 13:31:27 +0200 |
|---|---|---|
| committer | Katja Marttila <katja.marttila@qt.io> | 2019-12-17 06:43:31 +0000 |
| commit | eca45594967aba89c124a8b88ee8917b35d76181 (patch) | |
| tree | 4396223e2ae389c986188cf4942ee07a606fb877 /src/libs/kdtools | |
| parent | 4744ad130a2d4310e812a89da22d36a2e885b281 (diff) | |
Documentation fixes
Change-Id: Ibffb5470d374c8d612791f48c951deddd00f3121
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src/libs/kdtools')
| -rw-r--r-- | src/libs/kdtools/filedownloader.cpp | 20 | ||||
| -rw-r--r-- | src/libs/kdtools/localpackagehub.cpp | 3 |
2 files changed, 17 insertions, 6 deletions
diff --git a/src/libs/kdtools/filedownloader.cpp b/src/libs/kdtools/filedownloader.cpp index fce1a6208..f12b6df5d 100644 --- a/src/libs/kdtools/filedownloader.cpp +++ b/src/libs/kdtools/filedownloader.cpp @@ -148,6 +148,16 @@ static double calcProgress(qint64 done, qint64 total) */ /*! + \fn FileDownloader::downloadCompleted() + This signal is emitted when downloading a file ends. +*/ + +/*! + \fn FileDownloader::downloadAborted(const QString &errorMessage) + This signal is emitted when downloading a file is aborted with \a errorMessage. +*/ + +/*! \fn FileDownloader::estimatedDownloadTime(int seconds) This signal is emitted with the estimated download time in \a seconds. */ @@ -424,7 +434,7 @@ void KDUpdater::FileDownloader::stopDownloadDeadlineTimer() } /*! - Sets the download into a paused state. + Sets the download into a \a paused state. */ void KDUpdater::FileDownloader::setDownloadPaused(bool paused) { @@ -432,7 +442,7 @@ void KDUpdater::FileDownloader::setDownloadPaused(bool paused) } /*! - Gets the download paused state. + Returns the download paused state. */ bool KDUpdater::FileDownloader::isDownloadPaused() { @@ -440,7 +450,7 @@ bool KDUpdater::FileDownloader::isDownloadPaused() } /*! - Sets the download into a paused state. + Sets the download into a \a resumed state. */ void KDUpdater::FileDownloader::setDownloadResumed(bool resumed) { @@ -448,7 +458,7 @@ void KDUpdater::FileDownloader::setDownloadResumed(bool resumed) } /*! - Gets the download resumed state. + Returns the download resumed state. */ bool KDUpdater::FileDownloader::isDownloadResumed() { @@ -481,7 +491,7 @@ void KDUpdater::FileDownloader::clearBytesDownloadedBeforeResume() } /*! - Updates the amount of bytes downloaded before download resume. + Updates the amount of \a bytes downloaded before download resumes. */ void KDUpdater::FileDownloader::updateBytesDownloadedBeforeResume(qint64 bytes) { diff --git a/src/libs/kdtools/localpackagehub.cpp b/src/libs/kdtools/localpackagehub.cpp index 14e6b5738..d6208a610 100644 --- a/src/libs/kdtools/localpackagehub.cpp +++ b/src/libs/kdtools/localpackagehub.cpp @@ -311,7 +311,8 @@ void LocalPackageHub::refresh() \a virtualComp, \a uncompressedSize, \a inheritVersionFrom, - and \a checkable for the package. + \a checkable, + and \a expandedByDefault for the package. */ void LocalPackageHub::addPackage(const QString &name, const QString &version, |