From 7e3b963e3a0cbbf9391243e72ceb015e9015d630 Mon Sep 17 00:00:00 2001
From: Sebastien Braun
Date: Sat, 23 Oct 2010 17:49:12 +0200
Subject: Documentation fixes and code cleanup

---
 src/input/pvsPrivInputHandler.h | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src/input/pvsPrivInputHandler.h')

diff --git a/src/input/pvsPrivInputHandler.h b/src/input/pvsPrivInputHandler.h
index e82787b..015dfa1 100644
--- a/src/input/pvsPrivInputHandler.h
+++ b/src/input/pvsPrivInputHandler.h
@@ -24,10 +24,19 @@
 
 class QSocketNotifier;
 
+/**
+ * Handle socket communication with instances of the PVS Client Daemon.
+ *
+ * \note This runs in the context of a Qt main loop. It does not start
+ *   a handler thread.
+ */
 class PVSPrivInputHandler : public QObject
 {
 	Q_OBJECT
 public:
+	/**
+	 * Listen for InputEvents on file descriptor \c fd.
+	 */
 	PVSPrivInputHandler(int fd, QObject* parent = 0);
 	virtual ~PVSPrivInputHandler();
 
-- 
cgit v1.2.3-55-g7522