Changeset 57626 in vbox

Timestamp:

Sep 4, 2015 12:46:41 PM (9 years ago)

Author:

vboxsync

Message:

FE/Qt: Thread-pool: Doxy (part 2).

Location:

trunk/src/VBox/Frontends/VirtualBox/src/globals

Files:

• UIThreadPool.cpp (modified) (3 diffs)
• UIThreadPool.h (modified) (6 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIThreadPool.cpp

@@ -34 +34 @@
 
 
-/**
- * COM capable worker thread for the UIThreadPool.
- */
+/** QThread extension used as worker-thread.
+  * Capable of executing COM-related tasks. */
 class UIThreadWorker : public QThread
 {
@@ -43 +42 @@
 signals:
 
-    /* Notifier: Worker stuff: */
+    /** Notifies listeners about @a pWorker finished. */
     void sigFinished(UIThreadWorker *pWorker);
 
 public:
 
-    /* Constructor: */
+    /** Constructs worker-thread for parent worker-thread @a pPool.
+      * @param iIndex defines worker-thread index within the worker-thread pool registry. */
     UIThreadWorker(UIThreadPool *pPool, int iIndex);
 
+    /** Returns worker-thread index within the worker-thread pool registry. */
     int getIndex() const { return m_iIndex; }
 
-    /** Disables sigFinished. For optimizing pool termination. */
+    /** Disables sigFinished signal, for optimizing worker-thread pool termination. */
     void setNoFinishedSignal()
     {
@@ -61 +62 @@
 private:
 
-    /* Helper: Worker stuff: */
+    /** Contains the worker-thread body. */
     void run();
 
-    /* Variables: General stuff: */
+    /** Holds the worker-thread pool reference. */
     UIThreadPool *m_pPool;
 
-    /** The index into UIThreadPool::m_workers. */
+    /** Holds the worker-thread index within the worker-thread pool registry. */
     int m_iIndex;
-    /** Indicates whether sigFinished should be emitted or not. */
+
+    /** Holds whether sigFinished signal should be emitted or not. */
     bool m_fNoFinishedSignal;
 };

trunk/src/VBox/Frontends/VirtualBox/src/globals/UIThreadPool.h

@@ -52 +52 @@
     ~UIThreadPool();
 
-    /** Enqueues @a pTask into task-queue. */
+    /** Enqueues @a pTask into the task-queue. */
     void enqueueTask(UITask *pTask);
 
@@ -62 +62 @@
 protected:
 
-    /** Returns dequeued top-most task from the task-queue using @a pWorker as a hint.
-      * @remarks Called by the worker-thread. */
+    /** Returns dequeued top-most task from the task-queue.
+      * @remarks Called by the @a pWorker passed as a hint. */
     UITask* dequeueTask(UIThreadWorker *pWorker);
 
@@ -84 +84 @@
         QVector<UIThreadWorker*> m_workers;
         /** Holds the number of worker-threads.
-          * @remarks We cannot use the vector size since it may contain NULL pointers. */
+          * @remarks We cannot use the vector size since it may contain 0 pointers. */
         int m_cWorkers;
         /** Holds the number of idle worker-threads. */
@@ -114 +114 @@
 };
 
-/** QObject extension used as worker-thread task.
-  * Describes task to be executed by the UIThreadPool object. */
+/** QObject extension used as worker-thread task interface.
+  * Describes task to be executed by the UIThreadWorker object. */
 class UITask : public QObject
 {
@@ -128 +128 @@
 
     /** Constructs worker-thread task.
-      * @param data defines inter-thread task data to be processed by worker-thread. */
+      * @param data defines inter-thread task data to be processed
+      *             by worker-thread and returned back if necessary. */
     UITask(const QVariant &data);
 
@@ -140 +141 @@
     void start();
 
-    /** Contains the abstract task body, to be reimplemented in sub-class. */
+    /** Contains the abstract task body.
+      * @remarks To be reimplemented in sub-class. */
     virtual void run() = 0;
 
 //private:
 
-    /** Holds the inter-thread task data to be processed by worker-thread. */
+    /** Holds the inter-thread task data. */
     QVariant m_data;