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/magicSysRqHandler.h | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

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

diff --git a/src/input/magicSysRqHandler.h b/src/input/magicSysRqHandler.h
index ba02997..5afe259 100644
--- a/src/input/magicSysRqHandler.h
+++ b/src/input/magicSysRqHandler.h
@@ -19,16 +19,20 @@
 
 #include "inputEventHandler.h"
 
+/**
+ * Emulate the magic SysRq-Key on Linux.
+ */
 class MagicSysRqHandler : public InputEventHandler<
 	input_policy::Match<InputEvent::ET_SPECIAL, InputEvent::EC_SYSRQ>,
 	input_policy::Require<input_policy::LinuxSystem> >
 {
 public:
-	void doHandle(InputEvent const& evt, InputEventContext const* ctx);
 
-//	static void describeInto(QList<SpecialInputEventDescription>& list)
-//	{
-//	}
+	/**
+	 * Send the least significant byte of \c evt's InputEvent::value()
+	 * to the magic \c /proc/sysrq-trigger file.
+	 */
+	void doHandle(InputEvent const& evt, InputEventContext const* ctx);
 };
 
 #endif /* MAGICSYSRQHANDLER_H_ */
-- 
cgit v1.2.3-55-g7522