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/context2d/qquickcanvasitem.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/context2d/qquickcanvasitem.cpp')
-rw-r--r-- | src/quick/items/context2d/qquickcanvasitem.cpp | 22 |
1 files changed, 14 insertions, 8 deletions
diff --git a/src/quick/items/context2d/qquickcanvasitem.cpp b/src/quick/items/context2d/qquickcanvasitem.cpp index 8b9ad50a3f..ed05315824 100644 --- a/src/quick/items/context2d/qquickcanvasitem.cpp +++ b/src/quick/items/context2d/qquickcanvasitem.cpp @@ -896,9 +896,11 @@ QQmlRefPointer<QQuickCanvasPixmap> QQuickCanvasItem::loadedPixmap(const QUrl& ur } /*! - \qmlsignal QtQuick::Canvas::onImageLoaded() + \qmlsignal QtQuick::Canvas::imageLoaded() - This handler is called when an image has been loaded. + This signal is emitted when an image has been loaded. + + The corresponding handler is \c onImageLoaded. \sa loadImage() */ @@ -1098,20 +1100,24 @@ QRect QQuickCanvasItem::tiledRect(const QRectF &window, const QSize &tileSize) } /*! - \qmlsignal QtQuick::Canvas::onPaint(rect region) + \qmlsignal QtQuick::Canvas::paint(rect region) - This handler is called to render the \a region. If a context is active it - can be referenced from the context property. + This signal is emitted when the \a region needs to be rendered. If a context + is active it can be referenced from the context property. - This signal can be triggered markdirty(), requestPaint() or by changing + This signal can be triggered by markdirty(), requestPaint() or by changing the current canvas window. + + The corresponding handler is \c onPaint. */ /*! - \qmlsignal QtQuick::Canvas::onPainted() + \qmlsignal QtQuick::Canvas::painted() - This handler is called after all context painting commands are executed and + This signal is emitted after all context painting commands are executed and the Canvas has been rendered. + + The corresponding handler is \c onPainted. */ QT_END_NAMESPACE |