aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/items/qquickitemgrabresult.cpp
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2016-06-03 13:44:30 +0200
committerMitch Curtis <mitch.curtis@qt.io>2016-06-03 11:57:35 +0000
commitb6c64c2ef3b1fd314ea85be003fd88d43e36ee54 (patch)
treed416a6cdac19c1d72129efd71e9a3a9baaef9b96 /src/quick/items/qquickitemgrabresult.cpp
parent7039db4885a143f8f1d363c9b71665e9160d3d55 (diff)
Item: mention the actual type of the grab result
Change-Id: I2c73a4bdfa43200c52df33cec573a8799e4fe5e0 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
Diffstat (limited to 'src/quick/items/qquickitemgrabresult.cpp')
-rw-r--r--src/quick/items/qquickitemgrabresult.cpp3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/quick/items/qquickitemgrabresult.cpp b/src/quick/items/qquickitemgrabresult.cpp
index 939d19ea02..4e3e5570ee 100644
--- a/src/quick/items/qquickitemgrabresult.cpp
+++ b/src/quick/items/qquickitemgrabresult.cpp
@@ -321,7 +321,8 @@ QSharedPointer<QQuickItemGrabResult> QQuickItem::grabToImage(const QSize &target
* Grabs the item into an in-memory image.
*
* The grab happens asynchronously and the JavaScript function \a callback is
- * invoked when the grab is completed.
+ * invoked when the grab is completed. The callback takes one argument, which
+ * is the result of the grab operation; an \l ItemGrabResult object.
*
* Use \a targetSize to specify the size of the target image. By default, the result
* will have the same size as the item.