QtConcurrent: Add documentation for runWithPromise()

Task-number: QTBUG-84702
Change-Id: Ic8233aeffbdbd1420bdbde7ad7d03f25cd438ea8
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

1 files changed, 6 insertions, 1 deletions

diff --git a/src/concurrent/doc/src/qtconcurrent-index.qdoc b/src/concurrent/doc/src/qtconcurrent-index.qdoc
index cf4711476c..acb516fb63 100644
--- a/src/concurrent/doc/src/qtconcurrent-index.qdoc
+++ b/src/concurrent/doc/src/qtconcurrent-index.qdoc
@@ -81,10 +81,15 @@
             folded into a single result.
     \endlist
 
-    \li \l {Concurrent Run}
+    \li \l {Concurrent Run and Run With Promise}
     \list
         \li \l {QtConcurrent::run}{QtConcurrent::run()} runs a function in
             another thread.
+        \li \l {QtConcurrent::runWithPromise}{QtConcurrent::runWithPromise()}
+            is like run(), except that the function to run accepts additional
+            argument of QPromise type that enables more control over the function
+            execution, like suspending or canceling the execution when requested,
+            progress reporting or reporting multiple results.
     \endlist
 
     \li \l {Concurrent Task}