fdo-mirrors/libevdev
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libevdev/libevdev.git synced 2025-12-26 15:40:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: change @retval documentation to help doxygen with rendering

Browse source 
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>
This commit is contained in:
Peter Hutterer 2019-06-03 17:01:52 +10:00
parent c8be2b3260
commit a68e91b172
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
libevdev/libevdev.h
View file

@ -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