tstaskmonitor/client/src/tstaskmonitor.cpp
changeset 104 9b022b1f357c
parent 80 397d00875918
--- a/tstaskmonitor/client/src/tstaskmonitor.cpp	Wed Jun 23 18:33:40 2010 +0300
+++ b/tstaskmonitor/client/src/tstaskmonitor.cpp	Tue Jul 06 14:37:10 2010 +0300
@@ -20,17 +20,52 @@
 
 #include "tstask.h"
 
+/*!
+    @class TsTaskMonitor
+    @ingroup publicApi
+    @brief TsTaskMonitor gives access to list of running tasks.
+    
+    This class is one of the Qt interfaces for Task Monitor server. It can be
+    used to retrieve list of running tasks and receive notifications about the
+    changes of this list.
+*/
+
+/*!
+    Constructor.
+*/
 TsTaskMonitor::TsTaskMonitor(QObject *parent) : QObject(parent), d_ptr(0)
 {
     d_ptr = new TsTaskMonitorPrivate(this);
 }
 
+/*!
+    Destructor.
+*/
 TsTaskMonitor::~TsTaskMonitor()
 {
     delete d_ptr;
 }
 
+/*!
+    \return Current list of tasks from Task Monitor server.
+
+    \sa TsTask, taskListChanged()
+*/
 QList< QSharedPointer<TsTask> > TsTaskMonitor::taskList()
 {
     return d_ptr->taskList();
 }
+
+/*!
+    @fn TsTaskMonitor::taskListChanged()
+
+    This signal is emitted when task list changes in any way:
+    - the new task is started
+    - running task is terminated
+    - parameters of one task change (for example image representing the task is updated)
+
+    No data is passed within this signal, user should retrieve task list
+    using taskList().
+
+    \sa taskList()
+*/