diff options
author | Sze Howe Koh <szehowe.koh@gmail.com> | 2014-03-09 13:02:01 +0800 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-11 14:21:18 +0100 |
commit | 0e09aa0f2b64e8f62703a34018352cc3fa18fffc (patch) | |
tree | cbc458d03e85c9c7ad445f8e51d750ca35c50873 /src/qml/types/qqmlinstantiator.cpp | |
parent | 59fa9e3bb49ccdf1a764599aab63950bf156c370 (diff) |
Doc: Qt QML: Document signals (not handlers) under \qmlsignal
Task-number: QTBUG-35846
Change-Id: I989617865a79bfbf1f1ffd3b105598025dde54c5
Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/qml/types/qqmlinstantiator.cpp')
-rw-r--r-- | src/qml/types/qqmlinstantiator.cpp | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/src/qml/types/qqmlinstantiator.cpp b/src/qml/types/qqmlinstantiator.cpp index c28cfad9e3..724a76825b 100644 --- a/src/qml/types/qqmlinstantiator.cpp +++ b/src/qml/types/qqmlinstantiator.cpp @@ -212,22 +212,26 @@ QQmlInstantiator::~QQmlInstantiator() } /*! - \qmlsignal QtQml::Instantiator::onObjectAdded(int index, QtObject object) + \qmlsignal QtQml::Instantiator::objectAdded(int index, QtObject object) - This handler is called when an object is added to the Instantiator. The \a index + This signal is emitted when an object is added to the Instantiator. The \a index parameter holds the index which the object has been given, and the \a object parameter holds the \l QtObject that has been added. + + The corresponding handler is \c onObjectAdded. */ /*! - \qmlsignal QtQml::Instantiator::onObjectRemoved(int index, QtObject object) + \qmlsignal QtQml::Instantiator::objectRemoved(int index, QtObject object) - This handler is called when an object is added to the Instantiator. The \a index + This signal is emitted when an object is removed from the Instantiator. The \a index parameter holds the index which the object had been given, and the \a object parameter holds the \l QtObject that has been removed. Do not keep a reference to \a object if it was created by this Instantiator, as - in these cases it will be deleted shortly after the handler is called. + in these cases it will be deleted shortly after the signal is handled. + + The corresponding handler is \c onObjectRemoved. */ /*! \qmlproperty bool QtQml::Instantiator::active |