diff options
| author | Arttu Tarkiainen <arttu.tarkiainen@qt.io> | 2020-09-16 18:14:44 +0300 |
|---|---|---|
| committer | Arttu Tarkiainen <arttu.tarkiainen@qt.io> | 2020-09-21 06:44:32 +0000 |
| commit | 17f3e4fb3a2e560131527f91ca64944667223bd9 (patch) | |
| tree | 483eb0e64b5cf4adcab969bedaa88dba3d2b83ce /src/libs/installer/downloadarchivesjob.cpp | |
| parent | 7b16ab246d5c8241f08c0ffa3a87c9803ec4aa50 (diff) | |
Doc: Reduce the amount of documentation warnings
Miscellaneous fixes to missing function documentation, undocumented
parameters, namespace scope etc. As 5.12.7 based qdoc gives a lot
more warnings about code missing documentation, mark undocumented
implementation details with \internal command. Also some spelling
fixes to related parts of documentation.
Task-number: QTIFW-1483
Change-Id: Ibf5d1e5098713acbd152c5b61ea4f46cc11feb4b
Reviewed-by: Katja Marttila <katja.marttila@qt.io>
Diffstat (limited to 'src/libs/installer/downloadarchivesjob.cpp')
| -rw-r--r-- | src/libs/installer/downloadarchivesjob.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/libs/installer/downloadarchivesjob.cpp b/src/libs/installer/downloadarchivesjob.cpp index 4d9d6b325..5dbccc0b6 100644 --- a/src/libs/installer/downloadarchivesjob.cpp +++ b/src/libs/installer/downloadarchivesjob.cpp @@ -44,7 +44,7 @@ using namespace KDUpdater; /*! - Creates a new DownloadArchivesJob with \a parent. + Creates a new DownloadArchivesJob with parent \a core. */ DownloadArchivesJob::DownloadArchivesJob(PackageManagerCore *core) : Job(core) @@ -69,7 +69,7 @@ DownloadArchivesJob::~DownloadArchivesJob() } /*! - Sets the archives to download. The first value of each pair contains the file name to register + Sets the \a archives to download. The first value of each pair contains the file name to register the file in the installer's internal file system, the second one the source url. */ void DownloadArchivesJob::setArchivesToDownload(const QList<QPair<QString, QString> > &archives) @@ -175,7 +175,7 @@ void DownloadArchivesJob::fetchNextArchive() } /*! - Emits the global download progress during a single download in a lazy way (uses a timer to reduce to + Emits the global download \a progress during a single download in a lazy way (uses a timer to reduce to much processChanged). */ void DownloadArchivesJob::emitDownloadProgress(double progress) @@ -186,7 +186,7 @@ void DownloadArchivesJob::emitDownloadProgress(double progress) } /*! - This is used to reduce the progressChanged signals. + This is used to reduce the \c progressChanged signals for \a event. */ void DownloadArchivesJob::timerEvent(QTimerEvent *event) { |