aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/qml/qqmlcomponent.cpp
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2014-03-20 21:57:03 +0800
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-28 02:42:57 +0100
commit2341b58b76aea5c627cc656a2406256bac710227 (patch)
tree7a997207fd36eaecaf8953a50ce557cea12cc778 /src/qml/qml/qqmlcomponent.cpp
parent37fbfa4dc0de361eb05bc34077bdb8eab1113aad (diff)
Doc: Document signals (not handlers) under \qmlattachedsignal
- They're not "attached properties" either. - Append the handler names to the end of the corresponding signal doc. - Update descriptions and links Task-number: QTBUG-35846 Change-Id: I54e93187b3209546ec344a20e0482c98d7f14109 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/qml/qml/qqmlcomponent.cpp')
-rw-r--r--src/qml/qml/qqmlcomponent.cpp16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp
index f0e737516b..39a7d8905d 100644
--- a/src/qml/qml/qqmlcomponent.cpp
+++ b/src/qml/qml/qqmlcomponent.cpp
@@ -263,14 +263,14 @@ V8_DEFINE_EXTENSION(QQmlComponentExtension, componentExtension);
*/
/*!
- \qmlattachedsignal Component::onCompleted()
+ \qmlattachedsignal Component::completed()
Emitted after component "startup" has completed. This can be used to
execute script code at startup, once the full QML environment has been
established.
- The \c {Component::onCompleted} attached property can be declared on
- any object. The order of running the \c onCompleted scripts is
+ The corresponding handler is \c onCompleted. It can be declared on
+ any object. The order of running the \c onCompleted handlers is
undefined.
\qml
@@ -284,16 +284,16 @@ V8_DEFINE_EXTENSION(QQmlComponentExtension, componentExtension);
*/
/*!
- \qmlattachedsignal Component::onDestruction()
+ \qmlattachedsignal Component::destruction()
Emitted as the component begins destruction. This can be used to undo
- work done in the onCompleted signal, or other imperative code in your
- application.
+ work done in response to the \l {completed}{completed()} signal, or other
+ imperative code in your application.
- The \c {Component::onDestruction} attached property can be declared on
+ The corresponding handler is \c onDestruction. It can be declared on
any object. However, it applies to the destruction of the component as
a whole, and not the destruction of the specific object. The order of
- running the \c onDestruction scripts is undefined.
+ running the \c onDestruction handlers is undefined.
\qml
Rectangle {