diff options
author | Sze Howe Koh <szehowe.koh@gmail.com> | 2014-03-14 23:41:01 +0800 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-03-18 13:17:42 +0100 |
commit | 303db2e8a19ea1f2c1b8d5dc59e2754b0d03bd61 (patch) | |
tree | 9fed3403c91ab9b43aa30e660cbd1530439e6083 /src/quick/items/qquicktextedit.cpp | |
parent | d7ea461fde7a5d227313eda83b5af84ec9b0477b (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/quick/items/qquicktextedit.cpp')
-rw-r--r-- | src/quick/items/qquicktextedit.cpp | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/src/quick/items/qquicktextedit.cpp b/src/quick/items/qquicktextedit.cpp index 6fc1a3f4a5..017066d9a4 100644 --- a/src/quick/items/qquicktextedit.cpp +++ b/src/quick/items/qquicktextedit.cpp @@ -116,11 +116,13 @@ TextEdit { */ /*! - \qmlsignal QtQuick::TextEdit::onLinkActivated(string link) + \qmlsignal QtQuick::TextEdit::linkActivated(string link) - This handler is called when the user clicks on a link embedded in the text. + This signal is emitted when the user clicks on a link embedded in the text. The link must be in rich text or HTML format and the \a link string provides access to the particular link. + + The corresponding handler is \c onLinkActivated. */ // This is a pretty arbitrary figure. The idea is that we don't want to break down the document @@ -2509,13 +2511,15 @@ bool QQuickTextEditPrivate::isLinkHoveredConnected() } /*! - \qmlsignal QtQuick::TextEdit::onLinkHovered(string link) + \qmlsignal QtQuick::TextEdit::linkHovered(string link) \since 5.2 - This handler is called when the user hovers a link embedded in the text. + This signal is emitted when the user hovers a link embedded in the text. The link must be in rich text or HTML format and the \a link string provides access to the particular link. + The corresponding handler is \c onLinkHovered. + \sa hoveredLink, linkAt() */ |