Doc: add docs for arguments and return values

To get rid of QDoc errors.

Change-Id: I4932f1f3ff5fab87eebf24536d63be550582b195
Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>

6 files changed, 29 insertions, 11 deletions

diff --git a/src/libs/kdtools/kdupdaterapplication.cpp b/src/libs/kdtools/kdupdaterapplication.cpp
index bd766b436..43db97cfb 100644
--- a/src/libs/kdtools/kdupdaterapplication.cpp
+++ b/src/libs/kdtools/kdupdaterapplication.cpp
@@ -186,7 +186,8 @@ QString Application::applicationVersion() const
 }
 
 /*!
-    Adds update source info to this class.
+    Adds the \a name, \a title, \a description, \a url, and \a priority of the
+    update source to this class.
 
     \sa KDUpdater::UpdateSourceInfo
     \sa KDUpdater::UpdateSourcesInfo
@@ -232,8 +233,9 @@ PackagesInfo* Application::packagesInfo() const
 }
 
 /*!
-    Sets the file name of the update sources XML file for this application. By default, this is
-    assumed to be UpdateSources.xml in the application directory.
+    Sets \a fileName as the file name of the update sources XML file for this
+    application. By default, this is assumed to be UpdateSources.xml in the
+    application directory.
 
    \sa KDUpdater::UpdateSourcesInfo::setFileName()
 */
diff --git a/src/libs/kdtools/kdupdaterfiledownloaderfactory.cpp b/src/libs/kdtools/kdupdaterfiledownloaderfactory.cpp
index 39e6ba952..179a60247 100644
--- a/src/libs/kdtools/kdupdaterfiledownloaderfactory.cpp
+++ b/src/libs/kdtools/kdupdaterfiledownloaderfactory.cpp
@@ -121,8 +121,9 @@ bool FileDownloaderFactory::isSupportedScheme(const QString &scheme)
 }
 
 /*!
-     Returns a new instance of a KDUpdater::FileDownloader subclass. The subclass is instantiated
-     based on the communication protocol string stored in \a scheme.
+     Returns a new instance of a KDUpdater::FileDownloader subclass. The
+     instantiation of a subclass depends on the communication protocol string
+     stored in \a scheme with the parent \a parent.
 
      \note Ownership of the created object remains with the programmer.
 */
diff --git a/src/libs/kdtools/kdupdaterpackagesinfo.cpp b/src/libs/kdtools/kdupdaterpackagesinfo.cpp
index 6eb32f1e3..b19146660 100644
--- a/src/libs/kdtools/kdupdaterpackagesinfo.cpp
+++ b/src/libs/kdtools/kdupdaterpackagesinfo.cpp
@@ -325,7 +325,11 @@ void PackagesInfo::refresh()
 }
 
 /*!
-    Marks the package with \a name and \a version as installed.
+    Marks the package specified by \a name as installed. Sets the values of
+    \a version, \a title, \a description, \a dependencies, \a forcedInstallation,
+    \a virtualComp, \a uncompressedSize, and \a inheritVersionFrom for the
+    package.
+
 */
 bool PackagesInfo::installPackage(const QString &name, const QString &version,
                                   const QString &title, const QString &description,
@@ -353,8 +357,10 @@ bool PackagesInfo::installPackage(const QString &name, const QString &version,
 }
 
 /*!
-    Updates the package and sets the package name to \a name, the version to \a version and the
-    last update date to \a date.
+    Updates the package specified by \a name and sets its version to \a version
+    and the last update date to \a date.
+
+    Returns \c false if the package is not found.
 */
 bool PackagesInfo::updatePackage(const QString &name, const QString &version, const QDate &date)
 {
@@ -370,7 +376,9 @@ bool PackagesInfo::updatePackage(const QString &name, const QString &version, co
 }
 
 /*!
-    Remove the package with \a name.
+    Removes the package specified by \a name.
+
+    Returns \c false if the package is not found.
 */
 bool PackagesInfo::removePackage(const QString &name)
 {
diff --git a/src/libs/kdtools/kdupdaterupdate.cpp b/src/libs/kdtools/kdupdaterupdate.cpp
index e1f5b50db..eb260153f 100644
--- a/src/libs/kdtools/kdupdaterupdate.cpp
+++ b/src/libs/kdtools/kdupdaterupdate.cpp
@@ -60,7 +60,8 @@ Update::Update(int priority, const QUrl &sourceInfoUrl, const QHash<QString, QVa
 }
 
 /*!
-   Returns data whose name is given in parameter, or an invalid QVariant if the data doesn't exist.
+   Returns the data specified by \a name, or an invalid \a defaultValue if the
+   data does not exist.
 */
 QVariant Update::data(const QString &name, const QVariant &defaultValue) const
 {
diff --git a/src/libs/kdtools/kdupdaterupdatefinder.cpp b/src/libs/kdtools/kdupdaterupdatefinder.cpp
index e6c9044b8..7c155fff9 100644
--- a/src/libs/kdtools/kdupdaterupdatefinder.cpp
+++ b/src/libs/kdtools/kdupdaterupdatefinder.cpp
@@ -460,7 +460,8 @@ UpdateFinder::Private::Resolution UpdateFinder::Private::checkPriorityAndVersion
 //
 
 /*!
-   Constructs an update finder for a given KDUpdater::Application.
+   Constructs an update finder for the KDUpdater::Application specified by
+   \a application.
 */
 UpdateFinder::UpdateFinder(Application *application)
     : Task(QLatin1String("UpdateFinder"), Stoppable, application),
diff --git a/src/libs/kdtools/kdupdaterupdateoperation.cpp b/src/libs/kdtools/kdupdaterupdateoperation.cpp
index 67b10bedb..0693f768a 100644
--- a/src/libs/kdtools/kdupdaterupdateoperation.cpp
+++ b/src/libs/kdtools/kdupdaterupdateoperation.cpp
@@ -193,6 +193,11 @@ struct StartsWith
     QString m_searchTerm;
 };
 
+/*!
+    Searches the arguments for the key specified by \a key. If it can find the
+    key, it returns the value set for it. Otherwise, it returns \a defaultValue.
+    Arguments are specified in the following form: \c{key=value}.
+*/
 
 QString UpdateOperation::argumentKeyValue(const QString &key, const QString &defaultValue) const
 {