Add a comment to clarify what the prop parameter is
authorPeter Hutterer <peter.hutterer@who-t.net>
Sun, 11 Jan 2015 22:15:12 +0000 (08:15 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Tue, 13 Jan 2015 03:35:42 +0000 (13:35 +1000)
prop isn't the full property line, just the value.
And document the return value too while we're at it.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
src/libinput-util.c

index 923e1162859623fb46e5d4b1f394b8c59fe9e452..c16de1bf164244a0ecbf085ec5983c4d30466fee 100644 (file)
@@ -131,6 +131,9 @@ ratelimit_test(struct ratelimit *r)
  * use a reasonable default instead. If the property contains multiple DPI
  * settings but none flagged as default, we return the last because we're
  * lazy and that's a silly way to set the property anyway.
+ *
+ * @param prop The value of the udev property (without the MOUSE_DPI=)
+ * @return The default dpi value on success, 0 on error
  */
 int
 parse_mouse_dpi_property(const char *prop)