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 <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2015-01-12 08:15:12 +10:00
parent d28da2ca4e
commit 2ff009a45d

View 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)