summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDominik Holland <dominik.holland@qt.io>2024-02-07 17:09:21 +0100
committerDominik Holland <dominik.holland@qt.io>2024-02-07 18:01:36 +0100
commit1a737fddd47ee1d6ebc1e78bd0b985f10a310565 (patch)
tree0a9c12de46344f9d1502c7e4e493757e40587153
parent4ea59246e26d775294124d66bfc52326cba0c7f3 (diff)
doc: Add missing return types in IfSimulator QML methods documentation
Fixes: QTBUG-121800 Pick-to: 6.7 6.6 6.5 Change-Id: I81325b61d9436393fbb21b56d97e167b48d552fa Reviewed-by: Robert Griebl <robert.griebl@qt.io>
-rw-r--r--src/interfaceframework/qifsimulationglobalobject.cpp12
1 files changed, 6 insertions, 6 deletions
diff --git a/src/interfaceframework/qifsimulationglobalobject.cpp b/src/interfaceframework/qifsimulationglobalobject.cpp
index e7f39d56..f5f81133 100644
--- a/src/interfaceframework/qifsimulationglobalobject.cpp
+++ b/src/interfaceframework/qifsimulationglobalobject.cpp
@@ -248,7 +248,7 @@ void QIfSimulationGlobalObject::setSimulationData(const QVariant &simulationData
}
/*!
- \qmlmethod IfSimulator::findData(object data, string interface)
+ \qmlmethod var IfSimulator::findData(object data, string interface)
Searches for the key \a interface within \a data and returns the stored values. Returns
undefined if no data was found for this \a interface.
@@ -282,7 +282,7 @@ QVariantMap QIfSimulationGlobalObject::findData(const QVariantMap &data, const Q
}
/*!
- \qmlmethod IfSimulator::initializeDefault(object data, QObject* object)
+ \qmlmethod void IfSimulator::initializeDefault(object data, QObject* object)
Applies the default values read from \a data to \a object.
@@ -321,7 +321,7 @@ void QIfSimulationGlobalObject::initializeDefault(const QVariantMap &data, QObje
}
/*!
- \qmlmethod IfSimulator::defaultValue(object data, string zone)
+ \qmlmethod var IfSimulator::defaultValue(object data, string zone)
Provides the default value stored in \a data for the given \a zone. If \a zone is undefined or
the data doesn't provide a default value for the given \a zone, it returns the unzoned default
@@ -335,7 +335,7 @@ QVariant QIfSimulationGlobalObject::defaultValue(const QVariantMap &data, const
}
/*!
- \qmlmethod IfSimulator::constraint(object data, string zone)
+ \qmlmethod string IfSimulator::constraint(object data, string zone)
Searches for all boundary settings in \a data for the given \a zone and returns the constraint
(which is enforced for newly set values) in a human readable form.
@@ -376,7 +376,7 @@ QString QIfSimulationGlobalObject::constraint(const QVariantMap &data, const QSt
}
/*!
- \qmlmethod IfSimulator::checkSettings(object data, var value, string zone)
+ \qmlmethod bool IfSimulator::checkSettings(object data, var value, string zone)
Searches for all boundary settings in \a data for the given \a zone and returns whether the
provided \a value meets this constraint.
@@ -447,7 +447,7 @@ bool QIfSimulationGlobalObject::checkSettings(const QVariantMap &data, const QVa
}
/*!
- \qmlmethod IfSimulator::parseDomainValue(object data, string domain, string zone)
+ \qmlmethod var IfSimulator::parseDomainValue(object data, string domain, string zone)
Search for the \a domain in \a data for the given \a zone. If \a zone is undefined or
the data doesn't provide this domain for the given \a zone, it returns the unzoned domain