Doc: Correct documentation of QFuture::cancel

Fixes: QTBUG-76305
Change-Id: I192a7f0bc2c15e532bc6d51c7e9c39561ae3436c
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@qt.io>
 
 

3 files changed, 17 insertions, 17 deletions

diff --git a/src/concurrent/qtconcurrentrun.cpp b/src/concurrent/qtconcurrentrun.cpp
index bbd1f5ec62..d9867e1f1a 100644
--- a/src/concurrent/qtconcurrentrun.cpp
+++ b/src/concurrent/qtconcurrentrun.cpp
@@ -138,10 +138,10 @@
     T is the same type as the return value of \a function. Non-void return
     values can be accessed via the QFuture::result() function.
 
-    Note that the QFuture returned by QtConcurrent::run() does not support
-    canceling, pausing, or progress reporting. The QFuture returned can only
-    be used to query for the running/finished status and the return value of
-    the function.
+    \note The QFuture returned can only be used to query for the
+    running/finished status and the return value of the function. In particular,
+    canceling or pausing can be issued only if the computations behind the future
+    has not been started.
 
     \sa {Concurrent Run}
 */
@@ -157,10 +157,10 @@
     T is the same type as the return value of \a function. Non-void return
     values can be accessed via the QFuture::result() function.
 
-    Note that the QFuture returned by QtConcurrent::run() does not support
-    canceling, pausing, or progress reporting. The QFuture returned can only
-    be used to query for the running/finished status and the return value of
-    the function.
+    \note The QFuture returned can only be used to query for the
+    running/finished status and the return value of the function. In particular,
+    canceling or pausing can be issued only if the computations behind the future
+    has not been started.
 
     \sa {Concurrent Run}
 */
diff --git a/src/corelib/thread/qfuture.qdoc b/src/corelib/thread/qfuture.qdoc
index 7db65dacd3..076725e19c 100644
--- a/src/corelib/thread/qfuture.qdoc
+++ b/src/corelib/thread/qfuture.qdoc
@@ -55,8 +55,8 @@
     instance, the computation can be canceled with the cancel() function. To
     pause the computation, use the setPaused() function or one of the pause(),
     resume(), or togglePaused() convenience functions. Be aware that not all
-    asynchronous computations can be canceled or paused. For example, the
-    future returned by QtConcurrent::run() cannot be canceled; but the
+    running asynchronous computations can be canceled or paused. For example,
+    the future returned by QtConcurrent::run() cannot be canceled; but the
     future returned by QtConcurrent::mappedReduced() can.
 
     Progress information is provided by the progressValue(),
@@ -133,8 +133,8 @@
     Any QFutureWatcher object that is watching this future will not deliver
     progress and result ready signals on a canceled future.
 
-    Be aware that not all asynchronous computations can be canceled. For
-    example, the future returned by QtConcurrent::run() cannot be canceled;
+    Be aware that not all running asynchronous computations can be canceled.
+    For example, the future returned by QtConcurrent::run() cannot be canceled;
     but the future returned by QtConcurrent::mappedReduced() can.
 */
 
diff --git a/src/corelib/thread/qfuturewatcher.cpp b/src/corelib/thread/qfuturewatcher.cpp
index faeb6b3a28..8e90d043ef 100644
--- a/src/corelib/thread/qfuturewatcher.cpp
+++ b/src/corelib/thread/qfuturewatcher.cpp
@@ -84,8 +84,8 @@ QT_BEGIN_NAMESPACE
 
     \snippet code/src_corelib_thread_qfuturewatcher.cpp 0
 
-    Be aware that not all asynchronous computations can be canceled or paused.
-    For example, the future returned by QtConcurrent::run() cannot be
+    Be aware that not all running asynchronous computations can be canceled or
+    paused. For example, the future returned by QtConcurrent::run() cannot be
     canceled; but the future returned by QtConcurrent::mappedReduced() can.
 
     QFutureWatcher<void> is specialized to not contain any of the result
@@ -124,9 +124,9 @@ QFutureWatcherBase::QFutureWatcherBase(QObject *parent)
     progressRangeChanged(), progressTextChanged(), resultReadyAt(), and
     resultsReadyAt() signals.
 
-    Be aware that not all asynchronous computations can be canceled. For
-    example, the QFuture returned by QtConcurrent::run() cannot be canceled;
-    but the QFuture returned by QtConcurrent::mappedReduced() can.
+    Be aware that not all running asynchronous computations can be canceled.
+    For example, the QFuture returned by QtConcurrent::run() cannot be
+    canceled; but the QFuture returned by QtConcurrent::mappedReduced() can.
 */
 void QFutureWatcherBase::cancel()
 {