From 07f39c58c8b6ad7eb42aa41302f63ec20737b967 Mon Sep 17 00:00:00 2001 From: Arttu Tarkiainen Date: Thu, 17 Sep 2020 13:12:21 +0300 Subject: Doc: Remove internal classes and structs from generated documentation After migration to using 5.12.7 based qdoc, the generated documentation contains also empty declarations for members of undocumented internal classes. Mark them internal as needed. Task-number: QTIFW-1483 Change-Id: Iad40e4efdd098f09a825ce1c8d0aafcc76bd83bf Reviewed-by: Katja Marttila --- src/libs/installer/abstracttask.cpp | 47 ++++++++++++++++++++++ src/libs/installer/adminauthorization_x11.cpp | 6 +++ src/libs/installer/component_p.cpp | 5 +++ src/libs/installer/componentchecker.cpp | 6 +++ src/libs/installer/componentselectionpage_p.cpp | 6 +++ src/libs/installer/consumeoutputoperation.cpp | 6 +++ src/libs/installer/copydirectoryoperation.cpp | 6 +++ src/libs/installer/copyfiletask.cpp | 6 +++ src/libs/installer/createdesktopentryoperation.cpp | 6 +++ src/libs/installer/createlinkoperation.cpp | 6 +++ .../installer/createlocalrepositoryoperation.cpp | 5 +++ src/libs/installer/createshortcutoperation.cpp | 6 +++ src/libs/installer/downloadfiletask.cpp | 24 +++++++++++ src/libs/installer/elevatedexecuteoperation.cpp | 6 +++ .../installer/environmentvariablesoperation.cpp | 6 +++ src/libs/installer/errors.cpp | 35 ++++++++++++++++ src/libs/installer/extractarchiveoperation.cpp | 12 ++++++ .../fakestopprocessforupdateoperation.cpp | 6 +++ src/libs/installer/fileutils.cpp | 6 +++ src/libs/installer/globalsettingsoperation.cpp | 6 +++ src/libs/installer/graph.cpp | 35 ++++++++++++++++ src/libs/installer/installercalculator.cpp | 6 +++ src/libs/installer/installiconsoperation.cpp | 6 +++ src/libs/installer/keepaliveobject.cpp | 6 +++ src/libs/installer/licenseoperation.cpp | 6 +++ src/libs/installer/linereplaceoperation.cpp | 6 +++ src/libs/installer/metadatajob.cpp | 30 ++++++++++++++ src/libs/installer/minimumprogressoperation.cpp | 6 +++ src/libs/installer/observer.cpp | 12 ++++++ src/libs/installer/packagemanagercore_p.cpp | 6 +++ src/libs/installer/packagemanagercoredata.cpp | 6 +++ src/libs/installer/packagemanagerpagefactory.cpp | 6 +++ src/libs/installer/packagemanagerproxyfactory.cpp | 12 ++++++ src/libs/installer/permissionsettings.cpp | 6 +++ src/libs/installer/proxycredentialsdialog.cpp | 6 +++ src/libs/installer/qprocesswrapper.cpp | 6 +++ src/libs/installer/qsettingswrapper.cpp | 5 +++ src/libs/installer/registerfiletypeoperation.cpp | 6 +++ src/libs/installer/remoteclient.cpp | 12 ++++++ src/libs/installer/remotefileengine.cpp | 7 ++++ src/libs/installer/remoteobject.cpp | 6 +++ src/libs/installer/remoteserver.cpp | 12 ++++++ src/libs/installer/remoteserverconnection.cpp | 12 ++++++ src/libs/installer/replaceoperation.cpp | 6 +++ src/libs/installer/scriptengine.cpp | 24 +++++++++++ src/libs/installer/selfrestartoperation.cpp | 6 +++ src/libs/installer/serverauthenticationdialog.cpp | 6 +++ src/libs/installer/settings.cpp | 6 +++ src/libs/installer/settingsoperation.cpp | 6 +++ src/libs/installer/simplemovefileoperation.cpp | 6 +++ src/libs/installer/testrepository.cpp | 6 +++ src/libs/installer/uninstallercalculator.cpp | 6 +++ src/libs/installer/unziptask.cpp | 6 +++ src/libs/installer/utils.cpp | 18 +++++++++ src/libs/kdtools/updateoperations.cpp | 42 +++++++++++++++++++ 55 files changed, 571 insertions(+) create mode 100644 src/libs/installer/abstracttask.cpp create mode 100644 src/libs/installer/errors.cpp create mode 100644 src/libs/installer/graph.cpp diff --git a/src/libs/installer/abstracttask.cpp b/src/libs/installer/abstracttask.cpp new file mode 100644 index 000000000..31092dada --- /dev/null +++ b/src/libs/installer/abstracttask.cpp @@ -0,0 +1,47 @@ +/************************************************************************** +** +** 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 "abstracttask.h" + +/*! + \inmodule QtInstallerFramework + \class QInstaller::AbstractTask + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::AbstractTaskData + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::TaskException + \internal +*/ diff --git a/src/libs/installer/adminauthorization_x11.cpp b/src/libs/installer/adminauthorization_x11.cpp index 08b20b2f6..14691c9de 100644 --- a/src/libs/installer/adminauthorization_x11.cpp +++ b/src/libs/installer/adminauthorization_x11.cpp @@ -66,6 +66,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::AdminAuthorization + \internal +*/ + static QString getPassword(QWidget *parent) { if (qobject_cast (qApp) != 0) { diff --git a/src/libs/installer/component_p.cpp b/src/libs/installer/component_p.cpp index 8be0b1800..7c107cac2 100644 --- a/src/libs/installer/component_p.cpp +++ b/src/libs/installer/component_p.cpp @@ -35,6 +35,11 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::ComponentPrivate + \internal +*/ // -- ComponentPrivate diff --git a/src/libs/installer/componentchecker.cpp b/src/libs/installer/componentchecker.cpp index de8626329..b755d1260 100644 --- a/src/libs/installer/componentchecker.cpp +++ b/src/libs/installer/componentchecker.cpp @@ -35,6 +35,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::ComponentChecker + \internal +*/ + QStringList ComponentChecker::checkComponent(Component *component) { QStringList checkResult; diff --git a/src/libs/installer/componentselectionpage_p.cpp b/src/libs/installer/componentselectionpage_p.cpp index cb8f321d0..c5117e9cb 100644 --- a/src/libs/installer/componentselectionpage_p.cpp +++ b/src/libs/installer/componentselectionpage_p.cpp @@ -52,6 +52,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::ComponentSelectionPagePrivate + \internal +*/ + ComponentSelectionPagePrivate::ComponentSelectionPagePrivate(ComponentSelectionPage *qq, PackageManagerCore *core) : q(qq) , m_core(core) diff --git a/src/libs/installer/consumeoutputoperation.cpp b/src/libs/installer/consumeoutputoperation.cpp index 21f85470e..7b1b22946 100644 --- a/src/libs/installer/consumeoutputoperation.cpp +++ b/src/libs/installer/consumeoutputoperation.cpp @@ -38,6 +38,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::ConsumeOutputOperation + \internal +*/ + ConsumeOutputOperation::ConsumeOutputOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/copydirectoryoperation.cpp b/src/libs/installer/copydirectoryoperation.cpp index e83af07e1..4cef3facf 100644 --- a/src/libs/installer/copydirectoryoperation.cpp +++ b/src/libs/installer/copydirectoryoperation.cpp @@ -34,6 +34,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::CopyDirectoryOperation + \internal +*/ + class AutoPush { public: diff --git a/src/libs/installer/copyfiletask.cpp b/src/libs/installer/copyfiletask.cpp index 50626b682..72b28d896 100644 --- a/src/libs/installer/copyfiletask.cpp +++ b/src/libs/installer/copyfiletask.cpp @@ -34,6 +34,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::CopyFileTask + \internal +*/ + CopyFileTask::CopyFileTask(const FileTaskItem &item) : AbstractFileTask(item) { diff --git a/src/libs/installer/createdesktopentryoperation.cpp b/src/libs/installer/createdesktopentryoperation.cpp index e0f48e7af..5907e2f21 100644 --- a/src/libs/installer/createdesktopentryoperation.cpp +++ b/src/libs/installer/createdesktopentryoperation.cpp @@ -38,6 +38,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::CreateDesktopEntryOperation + \internal +*/ + QString CreateDesktopEntryOperation::absoluteFileName() { const QString filename = arguments().first(); diff --git a/src/libs/installer/createlinkoperation.cpp b/src/libs/installer/createlinkoperation.cpp index 851290ba8..3f29367b6 100644 --- a/src/libs/installer/createlinkoperation.cpp +++ b/src/libs/installer/createlinkoperation.cpp @@ -34,6 +34,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::CreateLinkOperation + \internal +*/ + CreateLinkOperation::CreateLinkOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/createlocalrepositoryoperation.cpp b/src/libs/installer/createlocalrepositoryoperation.cpp index 08e0693bd..1d194e5b3 100644 --- a/src/libs/installer/createlocalrepositoryoperation.cpp +++ b/src/libs/installer/createlocalrepositoryoperation.cpp @@ -50,6 +50,11 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::CreateLocalRepositoryOperation + \internal +*/ // -- AutoHelper diff --git a/src/libs/installer/createshortcutoperation.cpp b/src/libs/installer/createshortcutoperation.cpp index c4680d3e2..93044196d 100644 --- a/src/libs/installer/createshortcutoperation.cpp +++ b/src/libs/installer/createshortcutoperation.cpp @@ -39,6 +39,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::CreateShortcutOperation + \internal +*/ + #ifdef Q_OS_WIN #include #include diff --git a/src/libs/installer/downloadfiletask.cpp b/src/libs/installer/downloadfiletask.cpp index 626716223..d9f1e3432 100644 --- a/src/libs/installer/downloadfiletask.cpp +++ b/src/libs/installer/downloadfiletask.cpp @@ -41,6 +41,30 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::DownloadFileTask + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::Downloader + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::AuthenticationRequiredException + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::Data + \internal +*/ + AuthenticationRequiredException::AuthenticationRequiredException(Type type, const QString &message) : TaskException(message) , m_type(type) diff --git a/src/libs/installer/elevatedexecuteoperation.cpp b/src/libs/installer/elevatedexecuteoperation.cpp index 6a4fd99d9..f5640ef8d 100644 --- a/src/libs/installer/elevatedexecuteoperation.cpp +++ b/src/libs/installer/elevatedexecuteoperation.cpp @@ -39,6 +39,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::ElevatedExecuteOperation + \internal +*/ + class ElevatedExecuteOperation::Private { public: diff --git a/src/libs/installer/environmentvariablesoperation.cpp b/src/libs/installer/environmentvariablesoperation.cpp index df45b83f9..2f55172e1 100644 --- a/src/libs/installer/environmentvariablesoperation.cpp +++ b/src/libs/installer/environmentvariablesoperation.cpp @@ -41,6 +41,12 @@ using namespace QInstaller; using namespace KDUpdater; +/*! + \inmodule QtInstallerFramework + \class QInstaller::EnvironmentVariableOperation + \internal +*/ + EnvironmentVariableOperation::EnvironmentVariableOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/errors.cpp b/src/libs/installer/errors.cpp new file mode 100644 index 000000000..cbffadc5b --- /dev/null +++ b/src/libs/installer/errors.cpp @@ -0,0 +1,35 @@ +/************************************************************************** +** +** 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 "errors.h" + +/*! + \inmodule QtInstallerFramework + \class QInstaller::Error + \internal +*/ diff --git a/src/libs/installer/extractarchiveoperation.cpp b/src/libs/installer/extractarchiveoperation.cpp index ec7796f97..63e560e79 100644 --- a/src/libs/installer/extractarchiveoperation.cpp +++ b/src/libs/installer/extractarchiveoperation.cpp @@ -38,6 +38,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::ExtractArchiveOperation + \internal +*/ + /*! \typedef QInstaller::Backup @@ -51,6 +57,12 @@ namespace QInstaller { Synonym for QVector. */ +/*! + \inmodule QtInstallerFramework + \class QInstaller::WorkerThread + \internal +*/ + ExtractArchiveOperation::ExtractArchiveOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/fakestopprocessforupdateoperation.cpp b/src/libs/installer/fakestopprocessforupdateoperation.cpp index 69870fcab..36892eac7 100644 --- a/src/libs/installer/fakestopprocessforupdateoperation.cpp +++ b/src/libs/installer/fakestopprocessforupdateoperation.cpp @@ -34,6 +34,12 @@ using namespace KDUpdater; using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::FakeStopProcessForUpdateOperation + \internal +*/ + FakeStopProcessForUpdateOperation::FakeStopProcessForUpdateOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/fileutils.cpp b/src/libs/installer/fileutils.cpp index 147026a16..d0dd342a8 100644 --- a/src/libs/installer/fileutils.cpp +++ b/src/libs/installer/fileutils.cpp @@ -59,6 +59,12 @@ using namespace QInstaller; Default permissions for an executable file. */ +/*! + \inmodule QtInstallerFramework + \class QInstaller::TempDirDeleter + \internal +*/ + // -- TempDirDeleter TempDirDeleter::TempDirDeleter(const QString &path) diff --git a/src/libs/installer/globalsettingsoperation.cpp b/src/libs/installer/globalsettingsoperation.cpp index 0840cecf2..f1f184ceb 100644 --- a/src/libs/installer/globalsettingsoperation.cpp +++ b/src/libs/installer/globalsettingsoperation.cpp @@ -31,6 +31,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::GlobalSettingsOperation + \internal +*/ + GlobalSettingsOperation::GlobalSettingsOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/graph.cpp b/src/libs/installer/graph.cpp new file mode 100644 index 000000000..51bfa53c3 --- /dev/null +++ b/src/libs/installer/graph.cpp @@ -0,0 +1,35 @@ +/************************************************************************** +** +** 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 "graph.h" + +/*! + \inmodule QtInstallerFramework + \class QInstaller::Graph + \internal +*/ diff --git a/src/libs/installer/installercalculator.cpp b/src/libs/installer/installercalculator.cpp index edf5e7662..363837dd1 100644 --- a/src/libs/installer/installercalculator.cpp +++ b/src/libs/installer/installercalculator.cpp @@ -37,6 +37,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::InstallerCalculator + \internal +*/ + InstallerCalculator::InstallerCalculator(const QList &allComponents) : m_allComponents(allComponents) { diff --git a/src/libs/installer/installiconsoperation.cpp b/src/libs/installer/installiconsoperation.cpp index f6e4c589a..6b4852a6e 100644 --- a/src/libs/installer/installiconsoperation.cpp +++ b/src/libs/installer/installiconsoperation.cpp @@ -37,6 +37,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::InstallIconsOperation + \internal +*/ + QString InstallIconsOperation::targetDirectory() { // we're not searching for the first time, let's re-use the old value diff --git a/src/libs/installer/keepaliveobject.cpp b/src/libs/installer/keepaliveobject.cpp index f3b4e7779..94e91efd8 100644 --- a/src/libs/installer/keepaliveobject.cpp +++ b/src/libs/installer/keepaliveobject.cpp @@ -34,6 +34,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::KeepAliveObject + \internal +*/ + KeepAliveObject::KeepAliveObject() : m_timer(nullptr) , m_socket(nullptr) diff --git a/src/libs/installer/licenseoperation.cpp b/src/libs/installer/licenseoperation.cpp index 059798338..7296c6606 100644 --- a/src/libs/installer/licenseoperation.cpp +++ b/src/libs/installer/licenseoperation.cpp @@ -37,6 +37,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::LicenseOperation + \internal +*/ + LicenseOperation::LicenseOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/linereplaceoperation.cpp b/src/libs/installer/linereplaceoperation.cpp index 4d322e457..a384dbc4c 100644 --- a/src/libs/installer/linereplaceoperation.cpp +++ b/src/libs/installer/linereplaceoperation.cpp @@ -34,6 +34,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::LineReplaceOperation + \internal +*/ + LineReplaceOperation::LineReplaceOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/metadatajob.cpp b/src/libs/installer/metadatajob.cpp index 6fd1a48d6..a369461ca 100644 --- a/src/libs/installer/metadatajob.cpp +++ b/src/libs/installer/metadatajob.cpp @@ -44,6 +44,18 @@ const QStringList metaElements = {QLatin1String("Script"), QLatin1String("Licens namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::Metadata + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::ArchiveMetadata + \internal +*/ + /*! \enum QInstaller::DownloadType @@ -52,6 +64,24 @@ namespace QInstaller { \value UpdatesXML */ +/*! + \inmodule QtInstallerFramework + \class QInstaller::MetadataJob + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::UnzipArchiveTask + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::UnzipArchiveException + \internal +*/ + static QUrl resolveUrl(const FileTaskResult &result, const QString &url) { QUrl u(url); diff --git a/src/libs/installer/minimumprogressoperation.cpp b/src/libs/installer/minimumprogressoperation.cpp index 5ae571a59..c055a5c89 100644 --- a/src/libs/installer/minimumprogressoperation.cpp +++ b/src/libs/installer/minimumprogressoperation.cpp @@ -30,6 +30,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::MinimumProgressOperation + \internal +*/ + MinimumProgressOperation::MinimumProgressOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/observer.cpp b/src/libs/installer/observer.cpp index ee143193e..30afce719 100644 --- a/src/libs/installer/observer.cpp +++ b/src/libs/installer/observer.cpp @@ -31,6 +31,18 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::FileTaskObserver + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::Observer + \internal +*/ + FileTaskObserver::FileTaskObserver(QCryptographicHash::Algorithm algorithm) : m_hash(algorithm) { diff --git a/src/libs/installer/packagemanagercore_p.cpp b/src/libs/installer/packagemanagercore_p.cpp index c4a90e695..0057c5058 100644 --- a/src/libs/installer/packagemanagercore_p.cpp +++ b/src/libs/installer/packagemanagercore_p.cpp @@ -79,6 +79,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::PackageManagerCorePrivate + \internal +*/ + class OperationTracer { public: diff --git a/src/libs/installer/packagemanagercoredata.cpp b/src/libs/installer/packagemanagercoredata.cpp index 47c511c12..20dbecf00 100644 --- a/src/libs/installer/packagemanagercoredata.cpp +++ b/src/libs/installer/packagemanagercoredata.cpp @@ -44,6 +44,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::PackageManagerCoreData + \internal +*/ + PackageManagerCoreData::PackageManagerCoreData(const QHash &variables) { setDynamicPredefinedVariables(); diff --git a/src/libs/installer/packagemanagerpagefactory.cpp b/src/libs/installer/packagemanagerpagefactory.cpp index 808dec263..ba6faac84 100644 --- a/src/libs/installer/packagemanagerpagefactory.cpp +++ b/src/libs/installer/packagemanagerpagefactory.cpp @@ -30,6 +30,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::PackageManagerPageFactory + \internal +*/ + PackageManagerPageFactory &PackageManagerPageFactory::instance() { static PackageManagerPageFactory factory; diff --git a/src/libs/installer/packagemanagerproxyfactory.cpp b/src/libs/installer/packagemanagerproxyfactory.cpp index 93135aa1f..1ccbf8af1 100644 --- a/src/libs/installer/packagemanagerproxyfactory.cpp +++ b/src/libs/installer/packagemanagerproxyfactory.cpp @@ -35,6 +35,18 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::PackageManagerProxyFactory + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::ProxyCredential + \internal +*/ + PackageManagerProxyFactory::PackageManagerProxyFactory(const PackageManagerCore *const core) : m_core(core) { diff --git a/src/libs/installer/permissionsettings.cpp b/src/libs/installer/permissionsettings.cpp index cc0dfc7ab..6d5abdfe6 100644 --- a/src/libs/installer/permissionsettings.cpp +++ b/src/libs/installer/permissionsettings.cpp @@ -31,6 +31,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::PermissionSettings + \internal +*/ + PermissionSettings::~PermissionSettings() { if (!fileName().isEmpty()) { diff --git a/src/libs/installer/proxycredentialsdialog.cpp b/src/libs/installer/proxycredentialsdialog.cpp index 5ce941718..f536a05cd 100644 --- a/src/libs/installer/proxycredentialsdialog.cpp +++ b/src/libs/installer/proxycredentialsdialog.cpp @@ -38,6 +38,12 @@ namespace QInstaller { \brief Groups user interface forms generated with Qt Designer. */ +/*! + \inmodule QtInstallerFramework + \class QInstaller::ProxyCredentialsDialog + \internal +*/ + ProxyCredentialsDialog::ProxyCredentialsDialog(const QNetworkProxy &proxy, QWidget *parent) : QDialog(parent), ui(new Ui::ProxyCredentialsDialog) diff --git a/src/libs/installer/qprocesswrapper.cpp b/src/libs/installer/qprocesswrapper.cpp index 7cd5ad7d1..b33e7d43c 100644 --- a/src/libs/installer/qprocesswrapper.cpp +++ b/src/libs/installer/qprocesswrapper.cpp @@ -35,6 +35,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::QProcessWrapper + \internal +*/ + QProcessWrapper::QProcessWrapper(QObject *parent) : RemoteObject(QLatin1String(Protocol::QProcess), parent) { diff --git a/src/libs/installer/qsettingswrapper.cpp b/src/libs/installer/qsettingswrapper.cpp index 7bc2ffeb4..56db28d78 100644 --- a/src/libs/installer/qsettingswrapper.cpp +++ b/src/libs/installer/qsettingswrapper.cpp @@ -33,6 +33,11 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::QSettingsWrapper + \internal +*/ // -- QSettingsWrapper::Private diff --git a/src/libs/installer/registerfiletypeoperation.cpp b/src/libs/installer/registerfiletypeoperation.cpp index 27794652f..0a7c2eaa5 100644 --- a/src/libs/installer/registerfiletypeoperation.cpp +++ b/src/libs/installer/registerfiletypeoperation.cpp @@ -34,6 +34,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::RegisterFileTypeOperation + \internal +*/ + #ifdef Q_OS_WIN #include diff --git a/src/libs/installer/remoteclient.cpp b/src/libs/installer/remoteclient.cpp index ad1e5ecf6..54e174602 100644 --- a/src/libs/installer/remoteclient.cpp +++ b/src/libs/installer/remoteclient.cpp @@ -33,6 +33,18 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::RemoteClient + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::RemoteClientPrivate + \internal +*/ + RemoteClient *RemoteClient::s_instance = nullptr; RemoteClient::RemoteClient() diff --git a/src/libs/installer/remotefileengine.cpp b/src/libs/installer/remotefileengine.cpp index ae7c5c992..3c9ee217f 100644 --- a/src/libs/installer/remotefileengine.cpp +++ b/src/libs/installer/remotefileengine.cpp @@ -35,6 +35,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::RemoteFileEngineHandler + \internal +*/ + // -- RemoteFileEngineHandler QAbstractFileEngine* RemoteFileEngineHandler::create(const QString &fileName) const @@ -112,6 +118,7 @@ QString RemoteFileEngineIterator::currentFileName() const /*! \class QInstaller::RemoteFileEngine \inmodule QtInstallerFramework + \internal */ RemoteFileEngine::RemoteFileEngine() : RemoteObject(QLatin1String(Protocol::QAbstractFileEngine)) diff --git a/src/libs/installer/remoteobject.cpp b/src/libs/installer/remoteobject.cpp index c9c822299..1c521cdf3 100644 --- a/src/libs/installer/remoteobject.cpp +++ b/src/libs/installer/remoteobject.cpp @@ -37,6 +37,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::RemoteObject + \internal +*/ + RemoteObject::RemoteObject(const QString &wrappedType, QObject *parent) : QObject(parent) , dummy(nullptr) diff --git a/src/libs/installer/remoteserver.cpp b/src/libs/installer/remoteserver.cpp index 66cfefebb..7291f0c32 100644 --- a/src/libs/installer/remoteserver.cpp +++ b/src/libs/installer/remoteserver.cpp @@ -33,6 +33,18 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::LocalServer + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::RemoteServerPrivate + \internal +*/ + /*! Constructs an remote server object with \a parent. */ diff --git a/src/libs/installer/remoteserverconnection.cpp b/src/libs/installer/remoteserverconnection.cpp index 1efe46b85..a6b66c081 100644 --- a/src/libs/installer/remoteserverconnection.cpp +++ b/src/libs/installer/remoteserverconnection.cpp @@ -41,6 +41,18 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::RemoteServerConnection + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::QProcessSignalReceiver + \internal +*/ + RemoteServerConnection::RemoteServerConnection(qintptr socketDescriptor, const QString &key, QObject *parent) : QThread(parent) diff --git a/src/libs/installer/replaceoperation.cpp b/src/libs/installer/replaceoperation.cpp index 692bba715..3355bef71 100644 --- a/src/libs/installer/replaceoperation.cpp +++ b/src/libs/installer/replaceoperation.cpp @@ -35,6 +35,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::ReplaceOperation + \internal +*/ + ReplaceOperation::ReplaceOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/scriptengine.cpp b/src/libs/installer/scriptengine.cpp index d4ee63bdc..630829725 100644 --- a/src/libs/installer/scriptengine.cpp +++ b/src/libs/installer/scriptengine.cpp @@ -50,6 +50,30 @@ namespace QInstaller { Returns a global object. */ +/*! + \inmodule QtInstallerFramework + \class QInstaller::ConsoleProxy + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::InstallerProxy + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::QDesktopServicesProxy + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::QFileDialogProxy + \internal +*/ + QJSValue InstallerProxy::components() const { if (m_core) { diff --git a/src/libs/installer/selfrestartoperation.cpp b/src/libs/installer/selfrestartoperation.cpp index 586e5bb0b..8e53b8201 100644 --- a/src/libs/installer/selfrestartoperation.cpp +++ b/src/libs/installer/selfrestartoperation.cpp @@ -33,6 +33,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::SelfRestartOperation + \internal +*/ + SelfRestartOperation::SelfRestartOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/serverauthenticationdialog.cpp b/src/libs/installer/serverauthenticationdialog.cpp index 1b39e6980..3c995a810 100644 --- a/src/libs/installer/serverauthenticationdialog.cpp +++ b/src/libs/installer/serverauthenticationdialog.cpp @@ -34,6 +34,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::ServerAuthenticationDialog + \internal +*/ + ServerAuthenticationDialog::ServerAuthenticationDialog(const QString &m, const FileTaskItem &item) : ui(new Ui::ServerAuthenticationDialog) { diff --git a/src/libs/installer/settings.cpp b/src/libs/installer/settings.cpp index b0d631f60..0c54c4014 100644 --- a/src/libs/installer/settings.cpp +++ b/src/libs/installer/settings.cpp @@ -43,6 +43,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::Settings + \internal +*/ + /*! \typedef QInstaller::RepoHash diff --git a/src/libs/installer/settingsoperation.cpp b/src/libs/installer/settingsoperation.cpp index bece9b851..95ba5266d 100644 --- a/src/libs/installer/settingsoperation.cpp +++ b/src/libs/installer/settingsoperation.cpp @@ -36,6 +36,12 @@ using namespace QInstaller; +/*! + \inmodule QtInstallerFramework + \class QInstaller::SettingsOperation + \internal +*/ + SettingsOperation::SettingsOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/simplemovefileoperation.cpp b/src/libs/installer/simplemovefileoperation.cpp index d5cbde2ee..80654b367 100644 --- a/src/libs/installer/simplemovefileoperation.cpp +++ b/src/libs/installer/simplemovefileoperation.cpp @@ -33,6 +33,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::SimpleMoveFileOperation + \internal +*/ + SimpleMoveFileOperation::SimpleMoveFileOperation(PackageManagerCore *core) : UpdateOperation(core) { diff --git a/src/libs/installer/testrepository.cpp b/src/libs/installer/testrepository.cpp index 4ee2d41ae..3bbf304e7 100644 --- a/src/libs/installer/testrepository.cpp +++ b/src/libs/installer/testrepository.cpp @@ -36,6 +36,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::TestRepository + \internal +*/ + TestRepository::TestRepository(PackageManagerCore *parent) : Job(parent) , m_core(parent) diff --git a/src/libs/installer/uninstallercalculator.cpp b/src/libs/installer/uninstallercalculator.cpp index 20ad3c049..6fd63d499 100644 --- a/src/libs/installer/uninstallercalculator.cpp +++ b/src/libs/installer/uninstallercalculator.cpp @@ -36,6 +36,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::UninstallerCalculator + \internal +*/ + UninstallerCalculator::UninstallerCalculator(const QList &installedComponents) : m_installedComponents(installedComponents) { diff --git a/src/libs/installer/unziptask.cpp b/src/libs/installer/unziptask.cpp index e0fb5449a..2142baa8b 100644 --- a/src/libs/installer/unziptask.cpp +++ b/src/libs/installer/unziptask.cpp @@ -47,6 +47,12 @@ namespace QInstaller { +/*! + \inmodule QtInstallerFramework + \class QInstaller::UnzipTask + \internal +*/ + class ArchiveExtractCallback : public IArchiveExtractCallback, public CMyUnknownImp { public: diff --git a/src/libs/installer/utils.cpp b/src/libs/installer/utils.cpp index fb477f24e..d47caea89 100644 --- a/src/libs/installer/utils.cpp +++ b/src/libs/installer/utils.cpp @@ -51,6 +51,24 @@ #include #endif +/*! + \inmodule QtInstallerFramework + \class QInstaller::PlainVerboseWriterOutput + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::VerboseWriterOutput + \internal +*/ + +/*! + \inmodule QtInstallerFramework + \class QInstaller::VerboseWriter + \internal +*/ + /*! \internal */ diff --git a/src/libs/kdtools/updateoperations.cpp b/src/libs/kdtools/updateoperations.cpp index 856431f84..efd499d6d 100644 --- a/src/libs/kdtools/updateoperations.cpp +++ b/src/libs/kdtools/updateoperations.cpp @@ -95,6 +95,12 @@ static QString backupFileName(const QString &templateName) // KDUpdater::CopyOperation //////////////////////////////////////////////////////////////////////////// +/*! + \inmodule KDUpdater + \class KDUpdater::CopyOperation + \internal +*/ + CopyOperation::CopyOperation(QInstaller::PackageManagerCore *core) : UpdateOperation(core) { @@ -237,6 +243,12 @@ bool CopyOperation::testOperation() // KDUpdater::MoveOperation //////////////////////////////////////////////////////////////////////////// +/*! + \inmodule KDUpdater + \class KDUpdater::MoveOperation + \internal +*/ + MoveOperation::MoveOperation(QInstaller::PackageManagerCore *core) : UpdateOperation(core) { @@ -340,6 +352,12 @@ bool MoveOperation::testOperation() // KDUpdater::DeleteOperation //////////////////////////////////////////////////////////////////////////// +/*! + \inmodule KDUpdater + \class KDUpdater::DeleteOperation + \internal +*/ + DeleteOperation::DeleteOperation(QInstaller::PackageManagerCore *core) : UpdateOperation(core) { @@ -413,6 +431,12 @@ QDomDocument DeleteOperation::toXml() const // KDUpdater::MkdirOperation //////////////////////////////////////////////////////////////////////////// +/*! + \inmodule KDUpdater + \class KDUpdater::MkdirOperation + \internal +*/ + MkdirOperation::MkdirOperation(QInstaller::PackageManagerCore *core) : UpdateOperation(core) { @@ -511,6 +535,12 @@ bool KDUpdater::MkdirOperation::testOperation() // KDUpdater::RmdirOperation //////////////////////////////////////////////////////////////////////////// +/*! + \inmodule KDUpdater + \class KDUpdater::RmdirOperation + \internal +*/ + RmdirOperation::RmdirOperation(QInstaller::PackageManagerCore *core) : UpdateOperation(core) { @@ -575,6 +605,12 @@ bool RmdirOperation::testOperation() // KDUpdater::AppendFileOperation //////////////////////////////////////////////////////////////////////////// +/*! + \inmodule KDUpdater + \class KDUpdater::AppendFileOperation + \internal +*/ + AppendFileOperation::AppendFileOperation(QInstaller::PackageManagerCore *core) : UpdateOperation(core) { @@ -682,6 +718,12 @@ bool AppendFileOperation::testOperation() // KDUpdater::PrependFileOperation //////////////////////////////////////////////////////////////////////////// +/*! + \inmodule KDUpdater + \class KDUpdater::PrependFileOperation + \internal +*/ + PrependFileOperation::PrependFileOperation(QInstaller::PackageManagerCore *core) : UpdateOperation(core) { -- cgit v1.2.3