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>

1 files changed, 72 insertions, 0 deletions

diff --git a/src/libs/installer/qinstallerglobal.cpp b/src/libs/installer/qinstallerglobal.cpp
new file mode 100644
index 000000000..177a2595d
--- /dev/null
+++ b/src/libs/installer/qinstallerglobal.cpp
@@ -0,0 +1,72 @@
+/**************************************************************************
+**
+** 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 "qinstallerglobal.h"
+
+/*!
+    \enum QInstaller::JobError
+
+    \value InvalidUrl
+    \value Timeout
+    \value DownloadError
+    \value InvalidUpdatesXml
+    \value InvalidMetaInfo
+    \value ExtractionError
+    \value UserIgnoreError
+    \value RepositoryUpdatesReceived
+*/
+
+/*!
+    \typedef QInstaller::Operation
+
+    Synonym for KDUpdater::UpdateOperation.
+*/
+
+/*!
+    \typedef QInstaller::OperationList
+
+    Synonym for QList<QInstaller::Operation*>.
+*/
+
+/*!
+    \typedef QInstaller::Package
+
+    Synonym for KDUpdater::Update.
+*/
+
+/*!
+    \typedef QInstaller::PackagesList
+
+    Synonym for QList<QInstaller::Package*>.
+*/
+
+/*!
+    \typedef QInstaller::LocalPackagesHash
+
+    Synonym for QHash<QString, KDUpdater::LocalPackage>.
+*/