From 46cff6bce879200b0d76152584f0dac6a17d37b3 Mon Sep 17 00:00:00 2001
From: Roland Winklmeier <Roland.M.Winklmeier@gmail.com>
Date: Mon, 25 May 2015 23:57:13 +0200
Subject: [PATCH] Add doxygen note to CWorker

---
 src/blackmisc/worker.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/blackmisc/worker.h b/src/blackmisc/worker.h
index c9627f72f..d734eb15c 100644
--- a/src/blackmisc/worker.h
+++ b/src/blackmisc/worker.h
@@ -195,6 +195,8 @@ namespace BlackMisc
     public:
         /*!
          * Returns a new worker object which lives in a new thread.
+         * \note The worker calls its own deleteLater method when finished.
+         *       Typically assign it to a QPointer if you want to store it.
          * \param owner Will be the parent of the new thread (the worker has no parent).
          * \param name A name for the task, which will be used to create a name for the thread.
          * \param task A function object which will be run by the worker in its thread.