Add documentation for typedefs AutoDependencyHash and DependencyHash

Also use the typedefs in the code when possible.

Change-Id: Ie5aa55997051afc864de87d58a10db1c33312ff2
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Arttu Tarkiainen <arttu.tarkiainen@qt.io>

5 files changed, 26 insertions, 11 deletions

diff --git a/src/libs/installer/installercalculator.cpp b/src/libs/installer/installercalculator.cpp
index 307c0d2fb..60c0e5efd 100644
--- a/src/libs/installer/installercalculator.cpp
+++ b/src/libs/installer/installercalculator.cpp
@@ -41,7 +41,7 @@ namespace QInstaller {
     \internal
 */
 
-InstallerCalculator::InstallerCalculator(const QList<Component *> &allComponents, const QHash<QString, QStringList> &autoDependencyComponentHash)
+InstallerCalculator::InstallerCalculator(const QList<Component *> &allComponents, const AutoDependencyHash &autoDependencyComponentHash)
     : m_allComponents(allComponents)
     , m_autoDependencyComponentHash(autoDependencyComponentHash)
 {
diff --git a/src/libs/installer/installercalculator.h b/src/libs/installer/installercalculator.h
index 2841d8671..38909fde9 100644
--- a/src/libs/installer/installercalculator.h
+++ b/src/libs/installer/installercalculator.h
@@ -29,6 +29,7 @@
 #define INSTALLERCALCULATOR_H
 
 #include "installer_global.h"
+#include "qinstallerglobal.h"
 
 #include <QHash>
 #include <QList>
@@ -42,7 +43,7 @@ class Component;
 class INSTALLER_EXPORT InstallerCalculator
 {
 public:
-    InstallerCalculator(const QList<Component *> &allComponents, const QHash<QString, QStringList> &autoDependencyComponentHash);
+    InstallerCalculator(const QList<Component *> &allComponents, const AutoDependencyHash &autoDependencyComponentHash);
 
     enum InstallReasonType
     {
@@ -85,7 +86,7 @@ private:
     //the component is added
     QHash<QString, QPair<InstallReasonType, QString> > m_toInstallComponentIdReasonHash;
     //Helper hash for quicker search for autodependency components
-    QHash<QString, QStringList> m_autoDependencyComponentHash;
+    AutoDependencyHash m_autoDependencyComponentHash;
 };
 
 }
diff --git a/src/libs/installer/qinstallerglobal.cpp b/src/libs/installer/qinstallerglobal.cpp
index 6a67e9e10..8b1b9c6ad 100644
--- a/src/libs/installer/qinstallerglobal.cpp
+++ b/src/libs/installer/qinstallerglobal.cpp
@@ -74,11 +74,24 @@
 /*!
     \typedef QInstaller::AutoDependencyHash
 
-    Synonym for QHash<QString, QStringList>.
+    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::DependencyHash
 
-    Synonym for QHash<QString, QStringList>.
+    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
 */
diff --git a/src/libs/installer/uninstallercalculator.cpp b/src/libs/installer/uninstallercalculator.cpp
index 9bcacb246..c717f6550 100644
--- a/src/libs/installer/uninstallercalculator.cpp
+++ b/src/libs/installer/uninstallercalculator.cpp
@@ -44,8 +44,8 @@ namespace QInstaller {
 
 UninstallerCalculator::UninstallerCalculator(const QList<Component *> &installedComponents
          , PackageManagerCore *core
-         , const QHash<QString, QStringList> &autoDependencyComponentHash
-         , const QHash<QString, QStringList> &dependencyComponentHash
+         , const AutoDependencyHash &autoDependencyComponentHash
+         , const DependencyHash &dependencyComponentHash
          , const QStringList &localVirtualComponents)
     : m_installedComponents(installedComponents)
     , m_core(core)
diff --git a/src/libs/installer/uninstallercalculator.h b/src/libs/installer/uninstallercalculator.h
index 8bb9eb814..a458daa80 100644
--- a/src/libs/installer/uninstallercalculator.h
+++ b/src/libs/installer/uninstallercalculator.h
@@ -29,6 +29,7 @@
 #define UNINSTALLERCALCULATOR_H
 
 #include "installer_global.h"
+#include "qinstallerglobal.h"
 
 #include <QHash>
 #include <QList>
@@ -53,8 +54,8 @@ public:
     };
 
     UninstallerCalculator(const QList<Component *> &installedComponents, PackageManagerCore *core,
-                          const QHash<QString, QStringList> &autoDependencyComponentHash,
-                          const QHash<QString, QStringList> &dependencyComponentHash,
+                          const AutoDependencyHash &autoDependencyComponentHash,
+                          const DependencyHash &dependencyComponentHash,
                           const QStringList &localVirtualComponents);
 
     QSet<Component*> componentsToUninstall() const;
@@ -76,8 +77,8 @@ private:
     QSet<Component *> m_componentsToUninstall;
     PackageManagerCore *m_core;
     QHash<QString, QPair<UninstallReasonType, QString> > m_toUninstallComponentIdReasonHash;
-    QHash<QString, QStringList> m_autoDependencyComponentHash;
-    QHash<QString, QStringList> m_dependencyComponentHash;
+    AutoDependencyHash m_autoDependencyComponentHash;
+    DependencyHash m_dependencyComponentHash;
     QStringList m_localVirtualComponents;
     QList<Component *> m_virtualComponentsForReverse;
 };