Skip to content

docs: generate docs for evdev #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −52
Open

docs: generate docs for evdev #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 0 additions & 47 deletions docs/src/evdev/api/ecodes.md
View file
Open in desktop

This file was deleted.

22 changes: 17 additions & 5 deletions docs/src/evdev/types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,9 @@ Input device metadata.
| `vendor` | `integer` | No | Vendor ID from the kernel input ID. |
| `version` | `integer` | No | Hardware version from the kernel input ID. |

## [`evdev.ecodes.btn`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L9-L134)
## [`evdev.ecodes.btn`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L5-L134)

Button codes (e.g. mouse buttons, joysticks, gamepads).

| Name | Value |
| --------------------- | ----- |
Expand Down Expand Up @@ -181,7 +183,10 @@ Input device metadata.
| `BTN_Y` | `308` |
| `BTN_Z` | `309` |

## [`evdev.ecodes.ev`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L140-L156)
## [`evdev.ecodes.ev`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L136-L156)

Event types (e.g. key press, relative movement, absolute position,
synchronization).

| Name | Value |
| -------------- | ----- |
Expand All @@ -200,7 +205,9 @@ Input device metadata.
| `EV_SW` | `5` |
| `EV_SYN` | `0` |

## [`evdev.ecodes.key`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L162-L688)
## [`evdev.ecodes.key`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L158-L688)

Keyboard key codes.

| Name | Value |
| ------------------------------ | ----- |
Expand Down Expand Up @@ -729,7 +736,9 @@ Input device metadata.
| `KEY_ZOOMOUT` | `419` |
| `KEY_ZOOMRESET` | `420` |

## [`evdev.ecodes.rel`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L694-L711)
## [`evdev.ecodes.rel`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L690-L711)

Relative axis codes (e.g. mouse movement, scroll wheels).

| Name | Value |
| ------------------- | ----- |
Expand All @@ -749,7 +758,10 @@ Input device metadata.
| `REL_Y` | `1` |
| `REL_Z` | `2` |

## [`evdev.ecodes.syn`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L717-L725)
## [`evdev.ecodes.syn`](https://github.com/BlueLua/evdev/blob/main/types/_enums.d.lua#L713-L725)

Synchronization event codes used to group events or signal device status
changes.

| Name | Value |
| --------------- | ----- |
Expand Down