fdo-mirrors/libevdev
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libevdev/libevdev.git synced 2025-12-30 18:50:09 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add more cross-references

Browse source 
doxygen doesn't detect enum cross-references automatically, prefix them with
@ref

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2013-12-24 09:10:47 +10:00
parent 7da329b4d4
commit 590291513b
2 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
libevdev/libevdev-uinput.h
View file

@ -114,7 +114,7 @@ enum libevdev_uinput_open_mode {
* will be an exact copy of the libevdev device, minus the bits that uinput doesn't
* allow to be set.
*
* If uinput_fd is LIBEVDEV_UINPUT_OPEN_MANAGED, libevdev_uinput_create_from_device()
* If uinput_fd is @ref LIBEVDEV_UINPUT_OPEN_MANAGED, libevdev_uinput_create_from_device()
* will open @c /dev/uinput in read/write mode and manage the file descriptor.
* Otherwise, uinput_fd must be opened by the caller and opened with the
* appropriate permissions.
@ -133,7 +133,7 @@ enum libevdev_uinput_open_mode {
* source device.
*
* @param dev The device to duplicate
* @param uinput_fd LIBEVDEV_UINPUT_OPEN_MANAGED or a file descriptor to @c /dev/uinput,
* @param uinput_fd @ref LIBEVDEV_UINPUT_OPEN_MANAGED or a file descriptor to @c /dev/uinput,
* @param[out] uinput_dev The newly created libevdev device.
*
* @return 0 on success or a negative errno on failure. On failure, the value of
@ -150,9 +150,9 @@ int libevdev_uinput_create_from_device(const struct libevdev *dev,
*
* Destroy a previously created uinput device and free associated memory.
*
* If the device was opened with LIBEVDEV_UINPUT_OPEN_MANAGED, libevdev_uinput_destroy()
* also closes the file descriptor. Otherwise, the fd is left as-is and
* must be closed by the caller.
* If the device was opened with @ref LIBEVDEV_UINPUT_OPEN_MANAGED,
* libevdev_uinput_destroy() also closes the file descriptor. Otherwise, the
* fd is left as-is and must be closed by the caller.
*
* @param uinput_dev A previously created uinput device.
*

18
libevdev/libevdev.h
View file

@ -607,8 +607,8 @@ int libevdev_set_fd(struct libevdev* dev, int fd);
* changed, libevdev's behavior is undefined.
*
* libevdev does not sync itself after changing the fd and keeps the current
* device state. Use libevdev_next_event with the LIBEVDEV_FORCE_SYNC flag to
* force a re-sync.
* device state. Use libevdev_next_event with the
* @ref LIBEVDEV_READ_FLAG_FORCE_SYNC flag to force a re-sync.
*
* The fd may be open in O_RDONLY or O_RDWR.
*
@ -661,25 +661,25 @@ enum libevdev_read_status {
* Get the next event from the device. This function operates in two different
* modes: normal mode or sync mode.
*
* In normal mode, this function returns LIBEVDEV_READ_STATUS_SUCCESS and
* In normal mode, this function returns @ref LIBEVDEV_READ_STATUS_SUCCESS and
* returns the event in the parameter ev. If no events are available at this
* time, it returns -EAGAIN and ev is undefined.
*
* If a SYN_DROPPED is read from the device, this function returns
* LIBEVDEV_READ_STATUS_SYNC and ev is set to the EV_SYN event.
* @ref LIBEVDEV_READ_STATUS_SYNC and ev is set to the EV_SYN event.
* The caller should now call this function with the
* LIBEVDEV_READ_FLAG_SYNC flag set, to get the set of events that make up the
* device state delta. This function returns LIBEVDEV_READ_STATUS_SYNC for
* @ref LIBEVDEV_READ_FLAG_SYNC flag set, to get the set of events that make up the
* device state delta. This function returns @ref LIBEVDEV_READ_STATUS_SYNC for
* each event part of that delta, until it returns -EAGAIN once all events
* have been synced.
*
* If a device needs to be synced by the caller but the caller does not call
* with the LIBEVDEV_READ_STATUS_SYNC flag set, all events from the diff are
* with the @ref LIBEVDEV_READ_STATUS_SYNC flag set, all events from the diff are
* dropped and event processing continues as normal.
*
* @param dev The evdev device, already initialized with libevdev_set_fd()
* @param flags Set of flags to determine behaviour. If LIBEVDEV_READ_FLAG_NORMAL
* is set, the next event is read in normal mode. If LIBEVDEV_READ_FLAG_SYNC is
* @param flags Set of flags to determine behaviour. If @ref LIBEVDEV_READ_FLAG_NORMAL
* is set, the next event is read in normal mode. If @ref LIBEVDEV_READ_FLAG_SYNC is
* set, the next event is read in sync mode.
* @param ev On success, set to the current event.
* @return On failure, a negative errno is returned.