summaryrefslogtreecommitdiffstats
path: root/src/libs/installer/qinstallerglobal.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/libs/installer/qinstallerglobal.cpp')
-rw-r--r--src/libs/installer/qinstallerglobal.cpp33
1 files changed, 30 insertions, 3 deletions
diff --git a/src/libs/installer/qinstallerglobal.cpp b/src/libs/installer/qinstallerglobal.cpp
index 177a2595d..457690892 100644
--- a/src/libs/installer/qinstallerglobal.cpp
+++ b/src/libs/installer/qinstallerglobal.cpp
@@ -1,6 +1,6 @@
/**************************************************************************
**
-** Copyright (C) 2020 The Qt Company Ltd.
+** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Installer Framework.
@@ -39,6 +39,7 @@
\value ExtractionError
\value UserIgnoreError
\value RepositoryUpdatesReceived
+ \value CacheError
*/
/*!
@@ -66,7 +67,33 @@
*/
/*!
- \typedef QInstaller::LocalPackagesHash
+ \typedef QInstaller::LocalPackagesMap
- Synonym for QHash<QString, KDUpdater::LocalPackage>.
+ Synonym for QMap<QString, KDUpdater::LocalPackage>. The map key is component name,
+ and value contains information about the local package.
+*/
+
+/*!
+ \typedef QInstaller::AutoDependencyHash
+
+ Synonym for QHash<QString, QStringList>. The hash key is component name,
+ that other components automatically depend on. The value can contain
+ several component names, which are installed as an automatic dependency.
+ For example:
+ \badcode
+ <Name>A</Name> //Hash value
+ <AutoDependOn>B</AutoDependOn> //Hash key
+ \endcode
+*/
+
+/*!
+ \typedef QInstaller::LocalDependencyHash
+
+ Synonym for QHash<QString, QStringList>. The hash key is component name,
+ which other components depend on. The value can contain several component
+ names, which depend on the key. For example:
+ \badcode
+ <Name>A</Name> //Hash value
+ <Dependencies>B</Dependencies> //Hash key
+ \endcode
*/