feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Adapt withTimeout() to the recent changes

Browse Source 
Change-Id: I6abd9515735c8197411081f04618eb09c7b28069
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Jarek Kobus
2024-03-20 11:14:14 +01:00
parent 0a4b0e71d3
commit c8b66ebc77
1 changed files with 8 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
src/libs/solutions/tasking/tasktree.cpp
View File

@@ -547,18 +547,6 @@ private:
\endcode
*/
/*!
\fn GroupItem Group::withTimeout(std::chrono::milliseconds timeout, const std::function<void()> &handler) const
Attaches \c TimeoutTask to a copy of \c this group, elapsing after \a timeout in milliseconds,
with an optionally provided timeout \a handler, and returns the coupled item.
When the group finishes before \a timeout passes,
the returned item finishes immediately with the group's result.
Otherwise, the \a handler is invoked (if provided), the group's tasks are canceled,
and the returned item finishes with an error.
*/
/*!
\class Tasking::Sync
\inheaderfile solutions/tasking/tasktree.h
@@ -758,17 +746,6 @@ private:
\sa TaskSetupHandler, TaskDoneHandler
*/
/*!
\fn template <typename Adapter> GroupItem CustomTask<Adapter>::withTimeout(std::chrono::milliseconds timeout, const std::function<void()> &handler) const
Attaches \c TimeoutTask to a copy of \c this task, elapsing after \a timeout in milliseconds,
with an optionally provided timeout \a handler, and returns the coupled item.
When the task finishes before \a timeout passes, the returned item finishes immediately
with the task's result. Otherwise, \a handler is invoked (if provided),
the task is canceled, and the returned item finishes with an error.
*/
/*!
\enum Tasking::WorkflowPolicy
@@ -1415,6 +1392,14 @@ void GroupItem::addChildren(const QList<GroupItem> &children)
}
}
/*!
Attaches \c TimeoutTask to a copy of \c this ExecutableItem, elapsing after \a timeout
in milliseconds, with an optionally provided timeout \a handler, and returns the coupled item.
When the ExecutableItem finishes before \a timeout passes, the returned item finishes
immediately with the task's result. Otherwise, \a handler is invoked (if provided),
the task is canceled, and the returned item finishes with an error.
*/
ExecutableItem ExecutableItem::withTimeout(milliseconds timeout,
const std::function<void()> &handler) const
{