diff options
| -rw-r--r-- | src/tools/qdoc/doc/qdoc-manual.qdoc | 25 |
1 files changed, 9 insertions, 16 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual.qdoc b/src/tools/qdoc/doc/qdoc-manual.qdoc index 92b6b9f100..29147494fa 100644 --- a/src/tools/qdoc/doc/qdoc-manual.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual.qdoc @@ -5551,25 +5551,18 @@ \target qmlsignal-command \section1 \\qmlsignal - The \\qmlsignal command is for documenting a - \l{http://doc.qt.nokia.com/4.7/qdeclarativeintroduction.html#signal-handlers} - {signal handler}. - The argument is the rest of the line. It should be the QML type where the - signal handler is declared, the \c{::} qualifier, and finally the signal - handler name. If we have a QML signal handler named \c onAdd() in QML - element \c MouseArea, the \\qmlsignal for it would look like this: + The \\qmlsignal command is for documenting a QML signal. + The argument is the rest of the line. The arguments should be: the QML type + where the signal is declared, the \c{::} qualifier, and finally the signal + name. If we have a QML signal named \c clicked(), the documentation for it + would look like this: \code / *! - \qmlsignal MouseArea::onEntered() - - This handler is called when the mouse enters the mouse area. - - By default the onEntered handler is only called while a button is - pressed. Setting hoverEnabled to true enables handling of - onEntered when no mouse button is pressed. - - \sa hoverEnabled + \qmlsignal UIComponents::Button::clicked() + This signal is emitted when the user clicks the button. A click is defined + as a press followed by a release. The corresponding handler is + \c onClicked. * / \endcode |