From: Mikko Rasa <tdb@tdb.fi>
Date: Tue, 16 Aug 2011 12:55:47 +0000 (+0300)
Subject: Comment changes
X-Git-Url: http://git.tdb.fi/?a=commitdiff_plain;h=47df97f4381412236a02f0fcf71a2e9b23f78187;p=libs%2Fgui.git

Comment changes
---

diff --git a/source/input/binarycontrol.h b/source/input/binarycontrol.h
index fafa585..851c612 100644
--- a/source/input/binarycontrol.h
+++ b/source/input/binarycontrol.h
@@ -8,7 +8,8 @@ namespace Input {
 
 /**
 A control with two possible states.  Button state is mapped directly.  An axis
-is considered to be active when its value is within 10% of the end of the axis.
+is considered to be active when its value is above a threshold (0.5 by
+default).
 */
 class BinaryControl: public Control
 {
@@ -25,10 +26,8 @@ public:
 	BinaryControl(const ControlSource &);
 	BinaryControl(Device &, ControlSrcType, unsigned);
 
-	/**
-	Sets the threshold between states for axis sources.  No effect on button
-	sources
-	*/
+	/** Sets the threshold between states for axis sources.  No effect on button
+	sources */
 	void set_threshold(float);
 
 	bool get_state() const { return state; }
diff --git a/source/input/hub.h b/source/input/hub.h
index af4db47..9fe57dd 100644
--- a/source/input/hub.h
+++ b/source/input/hub.h
@@ -18,13 +18,8 @@ protected:
 public:
 	Hub();
 
-	/**
-	Attaches an input device to the hub.
-
-	@param   dev  Device to attach
-
-	@return  Index of the device within the hub
-	*/
+	/** Attaches an input device to the hub.  Returns the index of the device
+	within the hub. */
 	unsigned attach(Device &dev);
 
 	virtual std::string get_button_name(unsigned) const;