aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/types/qquickworkerscript.cpp
diff options
context:
space:
mode:
authorSze Howe Koh <szehowe.koh@gmail.com>2014-03-14 23:41:01 +0800
committerThe Qt Project <gerrit-noreply@qt-project.org>2014-03-18 13:17:42 +0100
commit303db2e8a19ea1f2c1b8d5dc59e2754b0d03bd61 (patch)
tree9fed3403c91ab9b43aa30e660cbd1530439e6083 /src/qml/types/qquickworkerscript.cpp
parentd7ea461fde7a5d227313eda83b5af84ec9b0477b (diff)
Doc: Document signals (not handlers) under \qmlsignal
Append the handler names to the end of the corresponding signal doc. Task-number: QTBUG-35846 Change-Id: I3d627ba7ed5be94e5c402ab092b4d582536499e8 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/qml/types/qquickworkerscript.cpp')
-rw-r--r--src/qml/types/qquickworkerscript.cpp6
1 files changed, 4 insertions, 2 deletions
diff --git a/src/qml/types/qquickworkerscript.cpp b/src/qml/types/qquickworkerscript.cpp
index e8fe75bee1..45fa191bc9 100644
--- a/src/qml/types/qquickworkerscript.cpp
+++ b/src/qml/types/qquickworkerscript.cpp
@@ -720,10 +720,12 @@ void QQuickWorkerScript::componentComplete()
}
/*!
- \qmlsignal WorkerScript::onMessage(jsobject msg)
+ \qmlsignal WorkerScript::message(jsobject msg)
- This handler is called when a message \a msg is received from a worker
+ This signal is emitted when a message \a msg is received from a worker
script in another thread through a call to sendMessage().
+
+ The corresponding handler is \c onMessage.
*/
bool QQuickWorkerScript::event(QEvent *event)