diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2019-06-03 17:01:52 +1000 |
|---|---|---|
| committer | Peter Hutterer <peter.hutterer@who-t.net> | 2019-06-03 17:48:28 +1000 |
| commit | a68e91b172211393e396074670d2111d02aa9760 (patch) | |
| tree | d3ec8802e234c581f46ee7c4235312f5929093f2 /libevdev | |
| parent | c8be2b32607c610eaefeefa428eb2ffb6a942d9c (diff) | |
| download | libevdev-a68e91b172211393e396074670d2111d02aa9760.tar.gz | |
doc: change @retval documentation to help doxygen with rendering
This causes some weird rendering, let's split it into a list (which also
happens to be more readable).
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'libevdev')
| -rw-r--r-- | libevdev/libevdev.h | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/libevdev/libevdev.h b/libevdev/libevdev.h index 63933bc..aa80e66 100644 --- a/libevdev/libevdev.h +++ b/libevdev/libevdev.h @@ -1531,9 +1531,12 @@ int libevdev_get_event_value(const struct libevdev *dev, unsigned int type, unsi * @param value The new value to set * * @return 0 on success, or -1 on failure. - * @retval -1 the device does not have the event type or code enabled, or the code is outside the - * allowed limits for the given type, or the type cannot be set, or the - * value is not permitted for the given code. + * @retval -1 + * - the device does not have the event type or + * - code enabled, or the code is outside the, or + * - the code is outside the allowed limits for the given type, or + * - the type cannot be set, or + * - the value is not permitted for the given code. * * @see libevdev_set_slot_value * @see libevdev_get_event_value @@ -1608,9 +1611,11 @@ int libevdev_get_slot_value(const struct libevdev *dev, unsigned int slot, unsig * @param value The new value to set * * @return 0 on success, or -1 on failure. - * @retval -1 the device does not have the event code enabled, or the code is - * outside the allowed limits for multitouch events, or the slot number is outside - * the limits for this device, or the device does not support multitouch events. + * @retval -1 + * - the device does not have the event code enabled, or + * - the code is outside the allowed limits for multitouch events, or + * - the slot number is outside the limits for this device, or + * - the device does not support multitouch events. * * @see libevdev_set_event_value * @see libevdev_get_slot_value |