Improve QQuickImageResponse::textureFactory documentation

Change-Id: Id754f1f1454af566cb3cf20f5ca947f972ef2caf
Reviewed-by: Robin Burchell <robin.burchell@viroteck.net>

diff --git a/src/quick/util/qquickimageprovider.cpp b/src/quick/util/qquickimageprovider.cpp
index 89615a2..5d492a4 100644 (file)
--- a/src/quick/util/qquickimageprovider.cpp
+++ b/src/quick/util/qquickimageprovider.cpp
@@ -194,8 +194,11 @@ void QQuickImageResponse::cancel()
     \fn QQuickTextureFactory *QQuickImageResponse::textureFactory() const
 
     Returns the texture factory for the job. You can use QQuickTextureFactory::textureFactoryForImage
-    if your provider works with QImage. This method is only called when the error string is not empty and the
-    engine takes ownership of the returned QQuickTextureFactory.
+    if your provider works with QImage. The engine takes ownership of the returned QQuickTextureFactory.
+
+     \note This method will be called only when needed. For example, it may not be called if there is an
+     error or the job is cancelled. Therefore, allocate the QQuickTextureFactory instance only in this
+     method or otherwise ensure its deletion.
  */