fdo-mirrors/libevdev
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libevdev/libevdev.git synced 2026-05-09 07:08:05 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add missing group assignment to a bunch of functions and enumerations

Browse source 
Without these, they won't show up in the documentation.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2013-09-11 11:47:39 +10:00
parent ab2f20bfd6
commit 4eb87a113a
1 changed files with 26 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
libevdev/libevdev.h
View file

@ -288,6 +288,9 @@ extern "C" {
*/ */
struct libevdev; struct libevdev;
/**
* @ingroup events
*/
enum libevdev_read_flag { enum libevdev_read_flag {
LIBEVDEV_READ_SYNC = 1, /**< Process data in sync mode */ LIBEVDEV_READ_SYNC = 1, /**< Process data in sync mode */
LIBEVDEV_READ_NORMAL = 2, /**< Process data in normal mode */ LIBEVDEV_READ_NORMAL = 2, /**< Process data in normal mode */
@ -349,13 +352,18 @@ int libevdev_new_from_fd(int fd, struct libevdev **dev);
*/ */
void libevdev_free(struct libevdev *dev); void libevdev_free(struct libevdev *dev);
/**
* @ingroup init
*/
enum libevdev_log_priority { enum libevdev_log_priority {
LIBEVDEV_LOG_ERROR = 10, /** cricitical errors and application bugs */ LIBEVDEV_LOG_ERROR = 10, /**< cricitical errors and application bugs */
LIBEVDEV_LOG_INFO = 20, /** informational messages */ LIBEVDEV_LOG_INFO = 20, /**< informational messages */
LIBEVDEV_LOG_DEBUG = 30, /** debug information */ LIBEVDEV_LOG_DEBUG = 30, /**< debug information */
}; };
/** /**
* @ingroup init
*
* Logging function called by library-internal logging. * Logging function called by library-internal logging.
* This function is expected to treat its input like printf would. * This function is expected to treat its input like printf would.
* *
@ -376,6 +384,8 @@ typedef void (*libevdev_log_func_t)(enum libevdev_log_priority priority,
const char *format, va_list args); const char *format, va_list args);
/** /**
* @ingroup init
*
* Set a printf-style logging handler for library-internal logging. The default * Set a printf-style logging handler for library-internal logging. The default
* logging function is to stdout. * logging function is to stdout.
* *
@ -388,6 +398,8 @@ typedef void (*libevdev_log_func_t)(enum libevdev_log_priority priority,
void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data); void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data);
/** /**
* @ingroup init
*
* Define the minimum level to be printed to the log handler. * Define the minimum level to be printed to the log handler.
* Messages higher than this level are printed, others are discarded. This * Messages higher than this level are printed, others are discarded. This
* is a global setting and applies to any future logging messages. * is a global setting and applies to any future logging messages.
@ -398,17 +410,23 @@ void libevdev_set_log_function(libevdev_log_func_t logfunc, void *data);
void libevdev_set_log_priority(enum libevdev_log_priority priority); void libevdev_set_log_priority(enum libevdev_log_priority priority);
/** /**
* @ingroup init
*
* @return the current log level * @return the current log level
*/ */
enum libevdev_log_priority libevdev_get_log_priority(void); enum libevdev_log_priority libevdev_get_log_priority(void);
/**
* @ingroup init
*/
enum libevdev_grab_mode { enum libevdev_grab_mode {
LIBEVDEV_GRAB = 3, LIBEVDEV_GRAB = 3, /**< Grab the device if not currently grabbed */
LIBEVDEV_UNGRAB = 4, LIBEVDEV_UNGRAB = 4, /**< Ungrab the device if currently grabbed */
}; };
/** /**
* @ingroup init
*
* Grab or ungrab the device through a kernel EVIOCGRAB. This prevents other * Grab or ungrab the device through a kernel EVIOCGRAB. This prevents other
* clients (including kernel-internal ones such as rfkill) from receiving * clients (including kernel-internal ones such as rfkill) from receiving
* events from this device. * events from this device.
@ -474,6 +492,8 @@ int libevdev_set_fd(struct libevdev* dev, int fd);
int libevdev_change_fd(struct libevdev* dev, int fd); int libevdev_change_fd(struct libevdev* dev, int fd);
/** /**
* @ingroup init
*
* @param dev The evdev device * @param dev The evdev device
* *
* @return The previously set fd, or -1 if none had been set previously. * @return The previously set fd, or -1 if none had been set previously.