From 2ff009a45dd59caf8747b5bbf0e16358a1a741a1 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Mon, 12 Jan 2015 08:15:12 +1000 Subject: [PATCH] Add a comment to clarify what the prop parameter is 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 --- src/libinput-util.c | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/libinput-util.c b/src/libinput-util.c index 923e1162..c16de1bf 100644 --- a/src/libinput-util.c +++ b/src/libinput-util.c @@ -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)