From 303db2e8a19ea1f2c1b8d5dc59e2754b0d03bd61 Mon Sep 17 00:00:00 2001 From: Sze Howe Koh Date: Fri, 14 Mar 2014 23:41:01 +0800 Subject: 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 --- src/quick/items/qquicktext.cpp | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) (limited to 'src/quick/items/qquicktext.cpp') diff --git a/src/quick/items/qquicktext.cpp b/src/quick/items/qquicktext.cpp index 287173957f..6c3750bcbc 100644 --- a/src/quick/items/qquicktext.cpp +++ b/src/quick/items/qquicktext.cpp @@ -1250,9 +1250,9 @@ QQuickText::~QQuickText() */ /*! - \qmlsignal QtQuick::Text::onLineLaidOut(object line) + \qmlsignal QtQuick::Text::lineLaidOut(object line) - This handler is called for each line of text that is laid out during the layout + This signal is emitted for each line of text that is laid out during the layout process. The specified \a line object provides more details about the line that is currently being laid out. @@ -1277,12 +1277,14 @@ QQuickText::~QQuickText() } } \endcode + + The corresponding handler is \c onLineLaidOut. */ /*! - \qmlsignal QtQuick::Text::onLinkActivated(string link) + \qmlsignal QtQuick::Text::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. @@ -1293,6 +1295,8 @@ QQuickText::~QQuickText() Clicking on the highlighted link will output \tt{http://qt-project.org link activated} to the console. + + The corresponding handler is \c onLinkActivated. */ /*! @@ -2566,13 +2570,15 @@ bool QQuickTextPrivate::isLinkHoveredConnected() } /*! - \qmlsignal QtQuick::Text::onLinkHovered(string link) + \qmlsignal QtQuick::Text::linkHovered(string link) \since 5.2 - This handler is called when the user hovers a link embedded in the + 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() */ -- cgit v1.2.3