Fix documentation warnings

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

6 files changed, 27 insertions, 8 deletions

diff --git a/doc/scripting-api/gui.qdoc b/doc/scripting-api/gui.qdoc
index 7047cfe0e..63a76b60b 100644
--- a/doc/scripting-api/gui.qdoc
+++ b/doc/scripting-api/gui.qdoc
@@ -58,6 +58,13 @@
 */
 
 /*!
+    \qmlsignal gui::aboutApplicationClicked()
+
+    This signal is emitted when the about application menu and dialog
+    on macOS are shown.
+*/
+
+/*!
     \qmlsignal gui::settingsButtonClicked()
 
     This signal is emitted when the \uicontrol Settings button is clicked.
diff --git a/src/libs/installer/component.cpp b/src/libs/installer/component.cpp
index 8e32ad347..714f3c70f 100644
--- a/src/libs/installer/component.cpp
+++ b/src/libs/installer/component.cpp
@@ -598,7 +598,7 @@ bool Component::treeNameMoveChildren() const
 
 /*!
     Loads the component script into the script engine. Call this method with
-    \c postLoad \c true to a list of components that are updated or installed
+    \a postLoad \c true to a list of components that are updated or installed
     to improve performance if the amount of components is huge and there are no script
     functions that need to be called before the installation starts.
 */
diff --git a/src/libs/installer/genericdatacache.cpp b/src/libs/installer/genericdatacache.cpp
index 45f3fa3e8..fd264ce63 100644
--- a/src/libs/installer/genericdatacache.cpp
+++ b/src/libs/installer/genericdatacache.cpp
@@ -512,7 +512,7 @@ QList<T *> GenericDataCache<T>::obsoleteItems() const
 }
 
 /*!
-   \fn template <typename T> QInstaller::GenericDataCache<T>::invalidate()
+   \internal
 
     Marks the cache invalid and clears all items. The contents
     on disk are not deleted. Releases the lock file of the cache.
@@ -532,7 +532,7 @@ void GenericDataCache<T>::invalidate()
 }
 
 /*!
-    \fn template <typename T> QInstaller::GenericDataCache<T>::setErrorString(const QString &error) const
+    \internal
 
     Sets the current error string to \a error and prints it as a warning to the console.
 */
@@ -544,7 +544,7 @@ void GenericDataCache<T>::setErrorString(const QString &error) const
 }
 
 /*!
-    \fn template <typename T> QInstaller::GenericDataCache<T>::fromDisk()
+    \internal
 
     Reads the manifest file of the cache if one exists, and populates the internal
     hash from the file contents. Returns \c true if the manifests was read successfully
@@ -598,7 +598,7 @@ bool GenericDataCache<T>::fromDisk()
 }
 
 /*!
-    \fn template <typename T> QInstaller::GenericDataCache<T>::toDisk()
+    \internal
 
     Writes the manifest file with the contents of the internal item hash.
     Returns \c true on success, \c false otherwise.
@@ -635,8 +635,6 @@ bool GenericDataCache<T>::toDisk()
 }
 
 /*!
-    \fn template <typename T> QInstaller::GenericDataCache<T>::remove(const QByteArray &checksum)
-
     \internal
 */
 template<typename T>
diff --git a/src/libs/installer/metadata.cpp b/src/libs/installer/metadata.cpp
index c9fa0a0f1..c90937bb8 100644
--- a/src/libs/installer/metadata.cpp
+++ b/src/libs/installer/metadata.cpp
@@ -256,7 +256,7 @@ QString Metadata::persistentRepositoryPath()
 }
 
 /*!
-    Checks whether the updates document of this metadata contains the repository
+    Returns true if the updates document of this metadata contains the repository
     update element, which can include actions to \c add, \c remove, and \c replace
     repositories.
 
diff --git a/src/libs/installer/packagemanagercore.cpp b/src/libs/installer/packagemanagercore.cpp
index 2a670f72d..8575fd271 100644
--- a/src/libs/installer/packagemanagercore.cpp
+++ b/src/libs/installer/packagemanagercore.cpp
@@ -1255,6 +1255,10 @@ PackageManagerCore::PackageManagerCore()
     Creates and initializes a remote client. Requests administrator's rights for
     QFile, QSettings, and QProcess operations. Calls \c init() with \a socketName, \a key,
     and \a mode to set the server side authorization key.
+
+    The \a datFileName contains the corresponding .dat file name for the running
+    \c maintenance tool binary. \a datFileName can be empty if \c maintenance tool
+    fails to find it or if \c installer is run instead of \c maintenance tool.
 */
 PackageManagerCore::PackageManagerCore(qint64 magicmaker, const QList<OperationBlob> &operations,
         const QString &datFileName,
diff --git a/src/libs/installer/packagemanagergui.cpp b/src/libs/installer/packagemanagergui.cpp
index b093838a3..b2d989946 100644
--- a/src/libs/installer/packagemanagergui.cpp
+++ b/src/libs/installer/packagemanagergui.cpp
@@ -283,6 +283,11 @@ public:
 */
 
 /*!
+    \fn void QInstaller::PackageManagerGui::aboutApplicationClicked()
+    \sa {gui::aboutApplicationClicked}{gui.aboutApplicationClicked}
+*/
+
+/*!
     \fn void QInstaller::PackageManagerGui::packageManagerCore() const
 
     Returns the package manager core.
@@ -2236,6 +2241,11 @@ void ComponentSelectionPage::showEvent(QShowEvent *event)
     QWizardPage::showEvent(event);
 }
 
+/*!
+    Called when \c ComponentSelectionPage is validated.
+    Tries to load \c component scripts for components about to be installed.
+    Returns \c true if the script loading succeeded and the next page is shown.
+*/
 bool ComponentSelectionPage::validatePage()
 {
     PackageManagerCore *core = packageManagerCore();