diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2017-01-26 15:19:18 +0100 |
|---|---|---|
| committer | Topi Reiniö <topi.reinio@qt.io> | 2017-01-30 10:52:11 +0000 |
| commit | 65d3a7e15307844a9afcc8fd6cefc8c88079450c (patch) | |
| tree | 0b50ac1fa073fb0d12e57d0adeda667046a5b98f /src/qml/qml/qqmlproperty.cpp | |
| parent | 0a5de1435271155fb3ec7780325e8c33b382da0a (diff) | |
Doc: Fix documentation warnings
src/qml/jsapi/qjsengine.cpp:524: warning:
Undocumented parameter 'metaObject' in QJSEngine::newQMetaObject()
src/qml/qml/qqmlengine.cpp:1023: warning:
Undocumented parameter 'retCode' in QQmlEngine::exit()
src/qml/doc/src/qmlfunctions.qdoc:182: warning:
Undocumented parameter 'reason' in qmlRegisterUncreatableMetaObject()
src/qml/qml/qqmllist.cpp:393: warning:
Undocumented parameter 'at' in QQmlListProperty::QQmlListProperty()
src/qml/qml/qqmllist.cpp:393: warning:
Undocumented parameter 'count' in QQmlListProperty::QQmlListProperty()
src/qml/qml/qqmllist.cpp:402: warning:
Undocumented parameter 'at' in QQmlListProperty::QQmlListProperty()
src/qml/qml/qqmllist.cpp:402: warning:
Undocumented parameter 'count' in QQmlListProperty::QQmlListProperty()
src/qml/qml/qqmllist.cpp:402: warning:
Undocumented parameter 'append' in QQmlListProperty::QQmlListProperty()
src/qml/qml/qqmllist.cpp:402: warning:
Undocumented parameter 'clear' in QQmlListProperty::QQmlListProperty()
src/quick/items/qquickwindow.cpp:4461: warning:
No such parameter 'backend' in QQuickWindow::setSceneGraphBackend()
Also do some minor language editing.
Change-Id: I2e806d1a77e3c4264d709c27d2bfc4542a782716
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src/qml/qml/qqmlproperty.cpp')
| -rw-r--r-- | src/qml/qml/qqmlproperty.cpp | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/src/qml/qml/qqmlproperty.cpp b/src/qml/qml/qqmlproperty.cpp index c62fef7c3d..0b8eb677cb 100644 --- a/src/qml/qml/qqmlproperty.cpp +++ b/src/qml/qml/qqmlproperty.cpp @@ -1400,9 +1400,9 @@ QQmlMetaObject QQmlPropertyPrivate::rawMetaObjectForType(QQmlEnginePrivate *engi } /*! - Sets the property value to \a value and returns true. - Returns false if the property can't be set because the - \a value is the wrong type, for example. + Sets the property value to \a value. Returns \c true on success, or + \c false if the property can't be set because the \a value is the + wrong type, for example. */ bool QQmlProperty::write(const QVariant &value) const { @@ -1417,6 +1417,8 @@ bool QQmlProperty::write(const QVariant &value) const QQmlProperty p(object, name); p.write(value); \endcode + + Returns \c true on success, \c false otherwise. */ bool QQmlProperty::write(QObject *object, const QString &name, const QVariant &value) { @@ -1433,6 +1435,8 @@ bool QQmlProperty::write(QObject *object, const QString &name, const QVariant &v QQmlProperty p(object, name, ctxt); p.write(value); \endcode + + Returns \c true on success, \c false otherwise. */ bool QQmlProperty::write(QObject *object, const QString &name, @@ -1453,6 +1457,8 @@ bool QQmlProperty::write(QObject *object, QQmlProperty p(object, name, engine); p.write(value); \endcode + + Returns \c true on success, \c false otherwise. */ bool QQmlProperty::write(QObject *object, const QString &name, const QVariant &value, QQmlEngine *engine) |