[PATCH libevdev 1/4] Add a doxygen page listing the ioctls and their current support

[David Herrmann]

Hi

Patch looks good, but besides ioctls, we also lack proper write()
support. So maybe it makes sense to extend this to a "syscalls" page
instead of only "ioctls"-page. Anyhow:

Reviewed-by: David Herrmann <dh.herrmann at gmail.com>

Thanks
David

On Wed, Dec 4, 2013 at 10:56 PM, Peter Hutterer
<peter.hutterer at who-t.net> wrote:
> Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
> ---
>  libevdev/libevdev.h | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 63 insertions(+), 1 deletion(-)
>
> diff --git a/libevdev/libevdev.h b/libevdev/libevdev.h
> index 3beca78..9b2de58 100644
> --- a/libevdev/libevdev.h
> +++ b/libevdev/libevdev.h
> @@ -34,7 +34,7 @@ extern "C" {
>   * @mainpage
>   *
>   * **libevdev** is a library for handling evdev kernel devices. It abstracts
> - * the ioctls through type-safe interfaces and provides functions to change
> + * the \ref ioctls through type-safe interfaces and provides functions to change
>   * the appearance of the device.
>   *
>   * Development of libevdev is discussed on
> @@ -246,6 +246,68 @@ extern "C" {
>   */
>
>  /**
> + * @page ioctls evdev ioctls
> + *
> + * This page lists the status of the evdev-specific ioctls in libevdev.
> + *
> + * <dl>
> + * <dt>EVIOCGVERSION:</dt>
> + * <dd>supported, see libevdev_get_driver_version()</dd>
> + * <dt>EVIOCGID:</dt>
> + * <dd>supported, see libevdev_get_id_product(), libevdev_get_id_vendor(),
> + * libevdev_get_id_bustype(), * * libevdev_get_id_version()</dd>
> + * <dt>EVIOCGREP:</dt>
> + * <dd>supported, see libevdev_get_repeat()</dd>
> + * <dt>EVIOCSREP:</dt>
> + * <dd>supported, see libevdev_enable_event_code()</dd>
> + * <dt>EVIOCGKEYCODE:</dt>
> + * <dd>currently not supported</dd>
> + * <dt>EVIOCGKEYCODE:</dt>
> + * <dd>currently not supported</dd>
> + * <dt>EVIOCSKEYCODE:</dt>
> + * <dd>currently not supported</dd>
> + * <dt>EVIOCSKEYCODE:</dt>
> + * <dd>currently not supported</dd>
> + * <dt>EVIOCGNAME:</dt>
> + * <dd>supported, see libevdev_get_name()</dd>
> + * <dt>EVIOCGPHYS:</dt>
> + * <dd>supported, see libevdev_get_phys()</dd>
> + * <dt>EVIOCGUNIQ:</dt>
> + * <dd>supported, see libevdev_get_uniq()</dd>
> + * <dt>EVIOCGPROP:</dt>
> + * <dd>supported, see libevdev_has_property()</dd>
> + * <dt>EVIOCGMTSLOTS:</dt>
> + * <dd>supported, see libevdev_get_num_slots(), libevdev_get_slot_value()</dd>
> + * <dt>EVIOCGKEY:</dt>
> + * <dd>supported, see libevdev_has_event_code(), libevdev_get_event_value()</dd>
> + * <dt>EVIOCGLED:</dt>
> + * <dd>supported, see libevdev_has_event_code(), libevdev_get_event_value()</dd>
> + * <dt>EVIOCGSND:</dt>
> + * <dd>currently not supported</dd>
> + * <dt>EVIOCGSW:</dt>
> + * <dd>supported, see libevdev_has_event_code(), libevdev_get_event_value()</dd>
> + * <dt>EVIOCGBIT:</dt>
> + * <dd>supported, see libevdev_has_event_code(), libevdev_get_event_value()</dd>
> + * <dt>EVIOCGABS:</dt>
> + * <dd>supported, see libevdev_has_event_code(), libevdev_get_event_value(),
> + * libevdev_get_abs_info()</dd>
> + * <dt>EVIOCSABS:</dt>
> + * <dd>supported, see libevdev_kernel_set_abs_info()</dd>
> + * <dt>EVIOCSFF:</dt>
> + * <dd>currently not supported</dd>
> + * <dt>EVIOCRMFF:</dt>
> + * <dd>currently not supported</dd>
> + * <dt>EVIOCGEFFECTS:</dt>
> + * <dd>currently not supported</dd>
> + * <dt>EVIOCGRAB:</dt>
> + * <dd>supported, see libevdev_grab()</dd>
> + * <dt>EVIOCSCLOCKID:</dt>
> + * <dd>supported, see libevdev_set_clock_id()</dd>
> + * </dl>
> + *
> + */
> +
> +/**
>   * @defgroup init Initialization and setup
>   *
>   * Initialization, initial setup and file descriptor handling.
> --
> 1.8.3.1
>
> _______________________________________________
> Input-tools mailing list
> Input-tools at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/input-tools