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>

4 files changed, 64 insertions, 1 deletions

diff --git a/src/libs/kdtools/sysinfo_x11.cpp b/src/libs/kdtools/sysinfo_x11.cpp
index 3099a369a..bc55939a6 100644
--- a/src/libs/kdtools/sysinfo_x11.cpp
+++ b/src/libs/kdtools/sysinfo_x11.cpp
@@ -44,6 +44,9 @@
 
 namespace KDUpdater {
 
+/*!
+    Returns the amount of memory installed on a system.
+*/
 quint64 installedMemory()
 {
 #ifdef Q_OS_LINUX
@@ -74,6 +77,9 @@ quint64 installedMemory()
     return 0;
 }
 
+/*!
+    Returns currently mounted volumes as list of the \c VolumeInfo objects.
+*/
 QList<VolumeInfo> mountedVolumes()
 {
     QList<VolumeInfo> result;
@@ -110,6 +116,9 @@ QList<VolumeInfo> mountedVolumes()
     return result;
 }
 
+/*!
+    Returns a list of currently running processes.
+*/
 QList<ProcessInfo> runningProcesses()
 {
     QList<ProcessInfo> processes;
@@ -131,6 +140,9 @@ QList<ProcessInfo> runningProcesses()
     return processes;
 }
 
+/*!
+    \internal
+*/
 bool pathIsOnLocalDevice(const QString &path)
 {
     Q_UNUSED(path);
@@ -138,6 +150,9 @@ bool pathIsOnLocalDevice(const QString &path)
     return true;
 }
 
+/*!
+    \internal
+*/
 bool killProcess(const ProcessInfo &process, int msecs)
 {
     Q_UNUSED(process);
diff --git a/src/libs/kdtools/updatefinder.cpp b/src/libs/kdtools/updatefinder.cpp
index 3adafe88e..c64d9b487 100644
--- a/src/libs/kdtools/updatefinder.cpp
+++ b/src/libs/kdtools/updatefinder.cpp
@@ -482,7 +482,7 @@ void UpdateFinder::setLocalPackageHub(std::weak_ptr<LocalPackageHub> hub)
 }
 
 /*!
-    Sets the package sources information to use when searching for applicable packages.
+    Sets the package \a sources information when searching for applicable packages.
 */
 void UpdateFinder::setPackageSources(const QSet<PackageSource> &sources)
 {
diff --git a/src/libs/kdtools/updateoperation.cpp b/src/libs/kdtools/updateoperation.cpp
index 0a61c0105..73e904da5 100644
--- a/src/libs/kdtools/updateoperation.cpp
+++ b/src/libs/kdtools/updateoperation.cpp
@@ -182,6 +182,11 @@ QStringList UpdateOperation::arguments() const
     return m_arguments;
 }
 
+/*!
+    Returns \c true if the argument count is within limits of \a minArgCount
+    and \a maxArgCount. \a argDescription contains information about the
+    expected form.
+*/
 bool UpdateOperation::checkArgumentCount(int minArgCount, int maxArgCount,
                                          const QString &argDescription)
 {
@@ -213,6 +218,9 @@ bool UpdateOperation::checkArgumentCount(int minArgCount, int maxArgCount,
     return true;
 }
 
+/*!
+    Returns \c true if the argument count is exactly \a argCount.
+*/
 bool UpdateOperation::checkArgumentCount(int argCount)
 {
     return checkArgumentCount(argCount, argCount);
diff --git a/src/libs/kdtools/updater.cpp b/src/libs/kdtools/updater.cpp
new file mode 100644
index 000000000..a3ac7c768
--- /dev/null
+++ b/src/libs/kdtools/updater.cpp
@@ -0,0 +1,40 @@
+/**************************************************************************
+**
+** Copyright (C) 2020 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt Installer Framework.
+**
+** $QT_BEGIN_LICENSE:GPL-EXCEPT$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+**************************************************************************/
+
+#include "updater.h"
+
+/*!
+    \enum KDUpdater::Error
+
+    \value ENoError
+    \value ECannotStartTask
+    \value ECannotPauseTask
+    \value ECannotResumeTask
+    \value ECannotStopTask
+    \value EUnknown
+*/