Doc: Describe shortly ExecutableItem class

Change-Id: Ib146d1c99e51c56ca46172d293d00392f05ddd46
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Jarek Kobus
2024-03-20 14:47:16 +01:00
parent 2cacb1444c
commit ab9f394138

View File

@@ -1392,6 +1392,18 @@ void GroupItem::addChildren(const QList<GroupItem> &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.