From fe9314573b4020b28697d66eba7daeb688cb1b2c Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Fri, 13 May 2016 11:50:18 +0200
Subject: Doc: Describe return values for boolean Component functions

...to suppress QDoc warnings.

Change-Id: Ib79b0392efaed37b4a52932d4f7d98327a3ad306
Reviewed-by: Katja Marttila <katja.marttila@qt.io>
---
 src/libs/installer/component.cpp | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

(limited to 'src/libs/installer/component.cpp')

diff --git a/src/libs/installer/component.cpp b/src/libs/installer/component.cpp
index ebd37a641..1e7edf725 100644
--- a/src/libs/installer/component.cpp
+++ b/src/libs/installer/component.cpp
@@ -1013,6 +1013,8 @@ Operation *Component::createOperation(const QString &operationName, const QStrin
     \a parameter1, \a parameter2, \a parameter3, \a parameter4, \a parameter5, \a parameter6,
     \a parameter7, \a parameter8, \a parameter9, and \a parameter10.
 
+    Returns \c true if the operation succeeds, otherwise returns \c false.
+
     \sa {component::addOperation}{component.addOperation}
 */
 bool Component::addOperation(const QString &operation, const QString &parameter1, const QString &parameter2,
@@ -1033,6 +1035,8 @@ bool Component::addOperation(const QString &operation, const QString &parameter1
     Creates and adds an installation operation for \a operation. Add any number of \a parameters.
     The variables that the parameters contain, such as \c @TargetDir@, are replaced with their
     values.
+
+    Returns \c true if the operation succeeds, otherwise returns \c false.
 */
 bool Component::addOperation(const QString &operation, const QStringList &parameters)
 {
@@ -1050,6 +1054,8 @@ bool Component::addOperation(const QString &operation, const QStringList &parame
     \a parameter7, \a parameter8, \a parameter9, and \a parameter10.
 
     \sa {component::addElevatedOperation}{component.addElevatedOperation}
+
+    Returns \c true if the operation succeeds, otherwise returns \c false.
 */
 bool Component::addElevatedOperation(const QString &operation, const QString &parameter1,
     const QString &parameter2, const QString &parameter3, const QString &parameter4, const QString &parameter5,
@@ -1070,6 +1076,8 @@ bool Component::addElevatedOperation(const QString &operation, const QString &pa
     The variables that the parameters contain, such as \c @TargetDir@, are replaced with their
     values. The operation is executed with elevated rights.
 
+    Returns \c true if the operation succeeds, otherwise returns \c false.
+
 */
 bool Component::addElevatedOperation(const QString &operation, const QStringList &parameters)
 {
@@ -1082,8 +1090,9 @@ bool Component::addElevatedOperation(const QString &operation, const QStringList
 }
 
 /*!
-    Specifies whether operations should be automatically created when the installation starts. This
-    would be done by calling createOperations(). If you set this to \c false, it is completely up
+    Returns whether operations should be automatically created when the
+    installation starts and createOperations() is called. If you set this to
+    \c false, it is completely up
     to the component's script to create all operations.
 
     \sa {component::autoCreateOperations}{component.autoCreateOperations}
-- 
cgit v1.2.3