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/privilegedHandlerForwarder.h | 13 +++++++++++++
 1 file changed, 13 insertions(+)

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

diff --git a/src/input/privilegedHandlerForwarder.h b/src/input/privilegedHandlerForwarder.h
index f5a6cc3..ea3326a 100644
--- a/src/input/privilegedHandlerForwarder.h
+++ b/src/input/privilegedHandlerForwarder.h
@@ -19,12 +19,25 @@
 
 #include "inputEventHandler.h"
 
+/**
+ * Forward the incoming InputEvent to \c pvsprivinputd.
+ */
 class PrivilegedHandlerForwarder : public InputEventHandler<
 	input_policy::Require<input_policy::UnixLike>,
 	input_policy::Unprivileged>
 {
 public:
+
+	/**
+	 * Forward \c evt to \c pvsprivinputd, taking care that
+	 * the security context is correctly sent.
+	 */
 	void doHandle(InputEvent const& evt, InputEventContext const* = 0);
+
+	/**
+	 * Read the address of \c pvsprivinputd's listening socket
+	 * from its configuration and connect to it.
+	 */
 	void initialize();
 
 private:
-- 
cgit v1.2.3-55-g7522