From 70cf6565f44c9ffd0c6ae0d46631642296bce6c0 Mon Sep 17 00:00:00 2001 From: itsmattkc Date: Sun, 30 Jun 2019 12:32:02 -0700 Subject: [PATCH] some taskthread documentation --- app/task/taskthread.h | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/app/task/taskthread.h b/app/task/taskthread.h index 7fff196fd..5d3fff208 100644 --- a/app/task/taskthread.h +++ b/app/task/taskthread.h @@ -25,6 +25,13 @@ class Task; +/** + * @brief The TaskThread class + * + * An internal class only used by Task. TaskThread is a simple QThread subclass designed to create a thread and run the + * Task's Action() function. It also stores the result of Action() which can be read using result() when the thread + * signals that it has finished(). + */ class TaskThread : public QThread { public: