diff options
| author | Vitaly Fanaskov <vitaly.fanaskov@qt.io> | 2020-03-31 11:22:02 +0200 |
|---|---|---|
| committer | Vitaly Fanaskov <vitaly.fanaskov@qt.io> | 2020-04-14 17:44:13 +0200 |
| commit | 678b9f78a5af4513ed4e988de90148584a2ae90d (patch) | |
| tree | 090b7970c739396d20a758bd87280b13ee9159cf /src/concurrent/qtaskbuilder.qdoc | |
| parent | c028cbccc248581ca37389fa50e02a988d006348 (diff) | |
QTaskBuilder::spawn: add an overload that doesn't return a future object
Fixes: QTBUG-83175
Change-Id: Idf85e47a2732742884272200d5c753805eaa640b
Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io>
Diffstat (limited to 'src/concurrent/qtaskbuilder.qdoc')
| -rw-r--r-- | src/concurrent/qtaskbuilder.qdoc | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/src/concurrent/qtaskbuilder.qdoc b/src/concurrent/qtaskbuilder.qdoc index 8352cae17a..1340307806 100644 --- a/src/concurrent/qtaskbuilder.qdoc +++ b/src/concurrent/qtaskbuilder.qdoc @@ -45,6 +45,13 @@ */ /*! + \fn template <class Task, class ...Args> void QtConcurrent::QTaskBuilder<Task, Args...>::spawn(QtConcurrent::FutureResult) + + Runs the task in a separate thread. This is a non-blocking call. + The task might not start immediately. +*/ + +/*! \fn template <class Task, class ...Args> template <class ...ExtraArgs> [[nodiscard]] QTaskBuilder<Task, ExtraArgs...> QtConcurrent::QTaskBuilder<Task, Args...>::withArguments(ExtraArgs &&...args) Sets the arguments \a args the task will be invoked with. The code is ill-formed @@ -80,3 +87,15 @@ The real implementation also contains a compile-time check for whether the task can be invoked with the specified arguments or not. */ + +/*! + \enum QtConcurrent::FutureResult + + This enum type is used to invoke a special overload of + QtConcurrent::QTaskBuilder::spawn(QtConcurrent::FutureResult) + that doesn't return a future object. + + \value Ignore + An auxiliary tag which introduced to improve code + readability. +*/ |