Fix documentation warnings

Change-Id: I934af4574de8a799ebed98376cc7e7bc0b2d6ece
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>

5 files changed, 15 insertions, 8 deletions

diff --git a/src/libs/installer/component.cpp b/src/libs/installer/component.cpp
index e045d7f29..36d207af7 100644
--- a/src/libs/installer/component.cpp
+++ b/src/libs/installer/component.cpp
@@ -90,6 +90,8 @@ static const QLatin1String scUnstable("Unstable");
             Component has dependencies to missing components.
     \value  InvalidTreeName
             Component has an invalid tree name.
+    \value  DescendantOfUnstable
+            Component is descendant of an unstable component.
 */
 
 /*!
diff --git a/src/libs/installer/genericdatacache.cpp b/src/libs/installer/genericdatacache.cpp
index 1b33976c8..683c945dc 100644
--- a/src/libs/installer/genericdatacache.cpp
+++ b/src/libs/installer/genericdatacache.cpp
@@ -75,7 +75,7 @@ static const QLatin1String scManifestFile("manifest.json");
 */
 
 /*!
-    \fn QInstaller::CacheableItem::isActive const
+    \fn QInstaller::CacheableItem::isActive() const
 
     Returns \c true if this item is an actively used cache item, \c false otherwise.
     This information is used as a hint for filtering obsolete entries, an active item
@@ -536,11 +536,11 @@ void GenericDataCache<T>::invalidate()
 }
 
 /*!
-    \fn template <typename T> QInstaller::GenericDataCache<T>::setErrorString(const QString &error)
+    \fn template <typename T> QInstaller::GenericDataCache<T>::setErrorString(const QString &error) const
 
     Sets the current error string to \a error and prints it as a warning to the console.
 */
-template<typename T>
+template <typename T>
 void GenericDataCache<T>::setErrorString(const QString &error) const
 {
     m_error = error;
diff --git a/src/libs/installer/qinstallerglobal.cpp b/src/libs/installer/qinstallerglobal.cpp
index 8b1b9c6ad..457690892 100644
--- a/src/libs/installer/qinstallerglobal.cpp
+++ b/src/libs/installer/qinstallerglobal.cpp
@@ -39,6 +39,7 @@
     \value ExtractionError
     \value UserIgnoreError
     \value RepositoryUpdatesReceived
+    \value CacheError
 */
 
 /*!
@@ -66,9 +67,10 @@
 */
 
 /*!
-    \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.
 */
 
 /*!
@@ -85,7 +87,7 @@
 */
 
 /*!
-    \typedef QInstaller::DependencyHash
+    \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
diff --git a/src/libs/kdtools/localpackagehub.cpp b/src/libs/kdtools/localpackagehub.cpp
index bd6d879e3..c7b627c51 100644
--- a/src/libs/kdtools/localpackagehub.cpp
+++ b/src/libs/kdtools/localpackagehub.cpp
@@ -313,6 +313,7 @@ void LocalPackageHub::refresh()
     \a title,
     \a treeName,
     \a description,
+    \a sortingPriority,
     \a dependencies,
     \a autoDependencies,
     \a forcedInstallation,
diff --git a/src/libs/kdtools/updateoperation.cpp b/src/libs/kdtools/updateoperation.cpp
index 657aab4a4..b35751096 100644
--- a/src/libs/kdtools/updateoperation.cpp
+++ b/src/libs/kdtools/updateoperation.cpp
@@ -328,8 +328,10 @@ void UpdateOperation::setRequiresUnreplacedVariables(bool isRequired)
     without _OLD ending. This way we can replace the hard coded values defined for operations,
     if the value has for some reason changed. For example if we set following variables
     in install script:
-    \snippet installer.setValue("MY_OWN_EXECUTABLE", "C:/Qt/NewLocation/Tools.exe")
-    \snippet installer.setValue("MY_OWN_EXECUTABLE_OLD", "C:/Qt/OldLocation/Tools.exe")
+    \badcode
+        installer.setValue("MY_OWN_EXECUTABLE", "C:/Qt/NewLocation/Tools.exe")
+        installer.setValue("MY_OWN_EXECUTABLE_OLD", "C:/Qt/OldLocation/Tools.exe")
+    \endcode
     and we have moved the Tools.exe from OldLocation to NewLocation, the operation
     continues to work and use the Tools.exe from NewLocation although original
     installation has been made with Tools.exe in OldLocation.