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

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

diff --git a/src/input/killX11Handler.h b/src/input/killX11Handler.h
index 77d9fdb..6501d5d 100644
--- a/src/input/killX11Handler.h
+++ b/src/input/killX11Handler.h
@@ -20,11 +20,22 @@
 #include <QCoreApplication>
 #include "inputEventHandler.h"
 
+/**
+ * Kills the X11 Server on Linux.
+ */
 class KillX11Handler : public InputEventHandler<
 	input_policy::Match<InputEvent::ET_SPECIAL, InputEvent::EC_KILL_X>,
 	input_policy::Require<input_policy::LinuxSystem> >
 {
 public:
+
+	/**
+	 * Kills the X11 Server on Linux.
+	 *
+	 * The X11-Server is found by asking ConsoleKit for its controlling
+	 * tty. The sole process that has an open file descriptor referencing it
+	 * must be the X Server. It is then sent SIGTERM.
+	 */
 	void doHandle(InputEvent const&, InputEventContext const*);
 };
 
-- 
cgit v1.2.3-55-g7522