diff options
author | Paul Wicking <paul.wicking@qt.io> | 2019-06-11 12:07:55 +0200 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2019-06-11 11:11:43 +0000 |
commit | 93642992ae779f3d8c864e5680ff2dfdfa9d0331 (patch) | |
tree | c8258e283230ca40578b5d0e5bf01653af12a01d /src/concurrent | |
parent | 1ade5ea41ab80e49e92fe46e0c44f76ee2e5e7fb (diff) |
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>
Diffstat (limited to 'src/concurrent')
-rw-r--r-- | src/concurrent/qtconcurrentrun.cpp | 16 |
1 files changed, 8 insertions, 8 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} */ |