mirror of
https://gitlab.freedesktop.org/libinput/libinput.git
synced 2026-01-01 15:10:08 +01:00
doc: document the base structures so they show up in doxygen
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
This commit is contained in:
parent
dc45db0467
commit
0e9beca049
1 changed files with 34 additions and 0 deletions
|
|
@ -302,8 +302,31 @@ enum libinput_event_type {
|
|||
LIBINPUT_EVENT_TOUCH_FRAME
|
||||
};
|
||||
|
||||
/**
|
||||
* @ingroup base
|
||||
* @struct libinput
|
||||
*
|
||||
* A handle for accessing libinput. This struct is refcounted, use
|
||||
* libinput_ref() and libinput_unref().
|
||||
*/
|
||||
struct libinput;
|
||||
|
||||
/**
|
||||
* @ingroup device
|
||||
* @struct libinput_device
|
||||
*
|
||||
* A base handle for accessing libinput devices. This struct is
|
||||
* refcounted, use libinput_device_ref() and libinput_device_unref().
|
||||
*/
|
||||
struct libinput_device;
|
||||
|
||||
/**
|
||||
* @ingroup seat
|
||||
* @struct libinput_seat
|
||||
*
|
||||
* The base handle for accessing libinput seats. This struct is
|
||||
* refcounted, use libinput_seat_ref() and libinput_seat_unref().
|
||||
*/
|
||||
struct libinput_seat;
|
||||
|
||||
/**
|
||||
|
|
@ -919,6 +942,17 @@ libinput_event_touch_get_base_event(struct libinput_event_touch *event);
|
|||
* @defgroup base Initialization and manipulation of libinput contexts
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup base
|
||||
* @struct libinput_interface
|
||||
*
|
||||
* libinput does not open file descriptors to devices directly, instead
|
||||
* open_restricted() and close_restricted() are called for each path that
|
||||
* must be opened.
|
||||
*
|
||||
* @see libinput_udev_create_context
|
||||
* @see libinput_path_create_context
|
||||
*/
|
||||
struct libinput_interface {
|
||||
/**
|
||||
* Open the device at the given path with the flags provided and
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue