diff options
| author | Sze Howe Koh <szehowe.koh@gmail.com> | 2014-03-19 22:37:57 +0800 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-26 07:22:35 +0100 |
| commit | cd08d34452c9dd1a7f69c93b5380bc39cb9a52bb (patch) | |
| tree | b998d2bb5c271222c9520e903b846d18c8ccc7d6 /src | |
| parent | 12bd35aa24c914046e30a46f650ed2e43c4956b1 (diff) | |
QDoc: Doc: Use correct terminology ("signal" vs. "signal handler")
Change-Id: I0c6cdc77296b8a1a759671bac2c920bc05d0cbcb
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc index 68f3f9652b..b9667b7758 100644 --- a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc @@ -1113,27 +1113,24 @@ \section1 \\qmlattachedsignal The \\qmlattachedsignal command is for documenting an attachable - \l{http://qt-project.org/doc/qt-4.7/qdeclarativeintroduction.html#signal-handlers} - {signal handler}. The \\qmlattachedsignal command is used just like - the \l{qmlsignal-command} {\\qmlsignal} command. + \l{Signal and Handler Event System}{signal}. The \\qmlattachedsignal + command is used just like the \l{qmlsignal-command} {\\qmlsignal} command. The argument is the rest of the line. It should be the name of the - QML type where the signal handler is declared, the \c{::} - qualifier, and finally the signal handler name. If we have a QML - attached signal handler named \c onAdd() in the \c GridView - element, the \\qmlattachedsignal for it would look like this: + QML type where the signal is declared, the \c{::} + qualifier, and finally the signal name. For example, a QML + attached signal named \c add() in the \c GridView + element is documented like this: \code / *! - \qmlattachedsignal GridView::onAdd() - This attached handler is called immediately after an item is - added to the view. + \qmlattachedsignal GridView::add() + This attached signal is emitted immediately after an item is added to the view. * / \endcode QDoc includes this documentation on the QML reference page for the - \l{http://qt-project.org/doc/qt-4.7/qml-gridview.html#onAdd-signal} - {GridView} element. + \l GridView element. \target qmlbasictype-command \section1 \\qmlbasictype |