Doc: Add docs for ExecutableItem::withLog()

Change-Id: I105a106139f1a658e5feed022e224e4e933dbcc1
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>

1 files changed, 11 insertions, 0 deletions

diff --git a/src/libs/solutions/tasking/tasktree.cpp b/src/libs/solutions/tasking/tasktree.cpp
index e74d165b29..7d37bf9758 100644
--- a/src/libs/solutions/tasking/tasktree.cpp
+++ b/src/libs/solutions/tasking/tasktree.cpp
@@ -1430,6 +1430,17 @@ ExecutableItem ExecutableItem::withTimeout(milliseconds timeout,
 
 static QString currentTime() { return QTime::currentTime().toString(Qt::ISODateWithMs); }
 
+/*!
+    Attaches a custom debug printout to a copy of \c this ExecutableItem,
+    issued on task startup and after the task is finished, and returns the coupled item.
+
+    The debug printout includes a timestamp of the event (start or finish)
+    and \a logName to identify the specific task in the debug log.
+
+    The finish printout contains the additional information whether the execution was
+    synchronous or asynchronous, its result (the value described by the DoneWith enum),
+    and the total execution time in milliseconds.
+*/
 ExecutableItem ExecutableItem::withLog(const QString &logName) const
 {
     const auto header = [logName] {