Doc: fix language and QDoc command issues

To follow the Qt documentation guidelines.

Change-Id: I8f533737b39d7d58645a05b033fc966f70918369
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>

4 files changed, 31 insertions, 22 deletions

diff --git a/src/libs/installer/packagemanagercore.cpp b/src/libs/installer/packagemanagercore.cpp
index 80d57ac4b..651d93bd5 100644
--- a/src/libs/installer/packagemanagercore.cpp
+++ b/src/libs/installer/packagemanagercore.cpp
@@ -166,8 +166,8 @@
 /*!
     \qmlsignal installer::metaJobProgress(int progress)
 
-    Triggered with progress updates of the while communicating with a remote repository. Progress
-    ranges from 0 to 100.
+    Triggered with progress updates of the communication with a remote
+    repository. Progress ranges from 0 to 100.
 */
 
 /*!
@@ -591,8 +591,8 @@ int PackageManagerCore::downloadNeededArchives(double partProgressSize)
 }
 
 /*!
-    If a component marked as important was installed during update
-    process true is returned.
+    Returns \c true if a component marked as essential was installed during the
+    update process.
 */
 bool PackageManagerCore::needsHardRestart() const
 {
@@ -1062,7 +1062,7 @@ void PackageManagerCore::setValidatorForCustomPage(Component *component, const Q
 /*!
     \qmlmethod boolean installer::addWizardPageItem(Component component, string name, int page)
 
-    Adds the widget with objectName() \a name registered by \a component as an GUI element
+    Adds the widget with objectName() \a name registered by \a component as a GUI element
     into the installer's GUI wizard. The widget is added on \a page.
 
     See \l{Controller Scripting} for the possible values of \a page.
@@ -1129,7 +1129,8 @@ void PackageManagerCore::setTemporaryRepositories(const QStringList &repositorie
 }
 
 /*!
-    Checks if the downloader should try to download sha1 checksums for archives.
+    Checks whether the downloader should try to download SHA-1 checksums for
+    archives.
 */
 bool PackageManagerCore::testChecksum() const
 {
@@ -1329,7 +1330,7 @@ QList<Component*> PackageManagerCore::orderedComponentsToInstall() const
     Calculates a list of components to uninstall based on the current run mode. Auto installed
     dependencies are not yet resolved.  The aboutCalculateComponentsToUninstall() signal is emitted
     before the calculation starts, the finishedCalculateComponentsToUninstall() signal once all
-    calculations are done. Returns always true.
+    calculations are done. Always returns \c true.
 */
 bool PackageManagerCore::calculateComponentsToUninstall() const
 {
@@ -1471,7 +1472,7 @@ void PackageManagerCore::dropAdminRights()
 /*!
     \qmlmethod boolean installer::isProcessRunning(string name)
 
-    Returns true, if a process with \a name is running. On Windows, the comparison
+    Returns \c true if a process with \a name is running. On Windows, the comparison
     is case-insensitive.
 */
 bool PackageManagerCore::isProcessRunning(const QString &name) const
@@ -1482,7 +1483,8 @@ bool PackageManagerCore::isProcessRunning(const QString &name) const
 /*!
     \qmlmethod boolean installer::killProcess(string absoluteFilePath)
 
-    Returns true, if a process with \a absoluteFilePath could be killed or isn't running
+    Returns \c true if a process with \a absoluteFilePath could be killed or is
+    not running.
 
     \note This is implemented in a semi blocking way (to keep the main thread to paint the UI).
 */
@@ -1633,7 +1635,7 @@ bool PackageManagerCore::executeDetached(const QString &program, const QStringLi
 /*!
     \qmlmethod string installer::environmentVariable(string name)
 
-    Returns content of an environment variable \a name. An empty string is returned if the
+    Returns the content of the environment variable \a name. An empty string is returned if the
     environment variable is not set.
 */
 QString PackageManagerCore::environmentVariable(const QString &name) const
@@ -1676,7 +1678,7 @@ bool PackageManagerCore::operationExists(const QString &name)
 /*!
     \qmlmethod boolean installer::performOperation(string name, stringlist arguments)
 
-    Instantly performs an operation \a name with \a arguments.
+    Instantly performs the operation \a name with \a arguments.
 */
 bool PackageManagerCore::performOperation(const QString &name, const QStringList &arguments)
 {
@@ -1697,7 +1699,7 @@ bool PackageManagerCore::performOperation(const QString &name, const QStringList
     \qmlmethod boolean installer::versionMatches(string version, string requirement)
 
     Returns \c true when \a version matches the \a requirement.
-    \a requirement can be a fixed version number or it can be prefix by the comparators '>', '>=',
+    \a requirement can be a fixed version number or it can be prefixed by the comparators '>', '>=',
     '<', '<=' and '='.
 */
 bool PackageManagerCore::versionMatches(const QString &version, const QString &requirement)
@@ -1793,7 +1795,8 @@ QString PackageManagerCore::findPath(const QString &name, const QStringList &pat
     Sets the "installerbase" binary to use when writing the maintenance tool.
     Set this if an update to installerbase is available.
 
-    If not set, the executable segment of the running un/installer will be used.
+    If not set, the executable segment of the running installer or uninstaller
+    will be used.
 */
 void PackageManagerCore::setInstallerBaseBinary(const QString &path)
 {
@@ -1905,8 +1908,8 @@ QString PackageManagerCore::error() const
 }
 
 /*!
-    Returns \c true if at least one complete installation/update was successful, even if the user cancelled the
-    newest installation process.
+    Returns \c true if at least one complete installation or update was
+    successful, even if the user cancelled the latest installation process.
 */
 bool PackageManagerCore::finishedWithSuccess() const
 {
@@ -1948,7 +1951,8 @@ QString PackageManagerCore::replaceVariables(const QString &str) const
 
 /*!
     \overload
-    Replaces all variables in any of \a str by their respective values and returns the results.
+    Replaces all variables in any instance of \a str by their respective values
+    and returns the results.
 */
 QStringList PackageManagerCore::replaceVariables(const QStringList &str) const
 {
@@ -2110,7 +2114,8 @@ void PackageManagerCore::languageChanged()
 }
 
 /*!
-    Runs the installer, un-installer, updater or package manager, depending on the type of this binary.
+    Runs the installer, uninstaller, updater, or package manager, depending on
+    the type of this binary.
 */
 bool PackageManagerCore::run()
 {
diff --git a/src/libs/installer/scriptengine.cpp b/src/libs/installer/scriptengine.cpp
index 057ce9c85..484987e3b 100644
--- a/src/libs/installer/scriptengine.cpp
+++ b/src/libs/installer/scriptengine.cpp
@@ -647,9 +647,9 @@ void ScriptEngine::removeFromGlobalObject(QObject *object)
     Loads a script into the given \a context at \a fileName inside the ScriptEngine.
 
     The installer and all its components as well as other useful stuff are being exported into the
-    script. Read \link componentscripting Component Scripting \endlink for details.
+    script. For more information, see \l {Component Scripting}.
     Throws Error when either the script at \a fileName could not be opened, or the QScriptEngine
-    couldn't evaluate the script.
+    could not evaluate the script.
 */
 QJSValue ScriptEngine::loadInContext(const QString &context, const QString &fileName,
     const QString &scriptInjection)
diff --git a/src/libs/kdtools/kdupdaterapplication.cpp b/src/libs/kdtools/kdupdaterapplication.cpp
index 43db97cfb..169e7e239 100644
--- a/src/libs/kdtools/kdupdaterapplication.cpp
+++ b/src/libs/kdtools/kdupdaterapplication.cpp
@@ -45,8 +45,12 @@ using namespace KDUpdater;
 /*!
     \inmodule kdupdater
     \namespace KDUpdater
-    \brief The KDUpdater classes where initially developed by KDAB to help provide automatic
-           updates for your applications. Now they are solely part of the Qt Installer Framework.
+    \brief The KDUpdater classes provide functions to automatically detect
+    updates to applications, to retrieve them from external repositories, and to
+    install them.
+
+    KDUpdater classes are a fork of KDAB's general
+    \l{http://docs.kdab.com/kdtools/2.2.2/group__kdupdater.html}{KDUpdater module}.
 */
 
 /*!
diff --git a/src/libs/kdtools/kdupdatertask.cpp b/src/libs/kdtools/kdupdatertask.cpp
index 922fc4c28..26dec6d14 100644
--- a/src/libs/kdtools/kdupdatertask.cpp
+++ b/src/libs/kdtools/kdupdatertask.cpp
@@ -119,7 +119,7 @@ QString Task::errorString() const
 }
 
 /*!
-   Returns whether the task has started and is running or not.
+   Returns whether the task has started and is running.
 */
 bool Task::isRunning() const
 {