From ab9f394138934c4cb581ca6f31a90e3cc3ad715a Mon Sep 17 00:00:00 2001 From: Jarek Kobus Date: Wed, 20 Mar 2024 14:47:16 +0100 Subject: [PATCH] Doc: Describe shortly ExecutableItem class Change-Id: Ib146d1c99e51c56ca46172d293d00392f05ddd46 Reviewed-by: Leena Miettinen --- src/libs/solutions/tasking/tasktree.cpp | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/libs/solutions/tasking/tasktree.cpp b/src/libs/solutions/tasking/tasktree.cpp index 9e28baab576..e74d165b297 100644 --- a/src/libs/solutions/tasking/tasktree.cpp +++ b/src/libs/solutions/tasking/tasktree.cpp @@ -1392,6 +1392,18 @@ void GroupItem::addChildren(const QList &children) } } +/*! + \class Tasking::ExecutableItem + \inheaderfile solutions/tasking/tasktree.h + \inmodule TaskingSolution + \brief Base class for executable task items. + \reentrant + + \c ExecutableItem provides an additional interface for items containing executable tasks. + Use withTimeout() to attach a timeout to a task. + Use withLog() to include debugging information about the task startup and the execution result. +*/ + /*! 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.