docs(evdev): generate API docs (#13)

Co-authored-by: haithium <128622475+haithium@users.noreply.github.com>

Author: github-actions[bot]

docs/src/evdev/api/device.md

@@ -110,8 +110,6 @@ local Device = evdev.device.open
 local dev = assert(Device("/dev/input/eventX"))
 
 assert(dev:grab())
-os.execute("sleep 3")
-
 -- Move the mouse or press keys during the sleep.
 
 local dropped = assert(dev:flush())

docs/src/evdev/api/uinput.md

@@ -8,13 +8,16 @@ Configuration used to create a `/dev/uinput` virtual device.
 
 ## Functions
 
-| Function                              | Description                                      |
-| ------------------------------------- | ------------------------------------------------ |
-| [`close()`](#fn-close)                | Destroy and close the virtual device.            |
-| [`create(spec?)`](#fn-create)         | Create a virtual input device.                   |
-| [`emit(type, code, value)`](#fn-emit) | Emit one raw input event.                        |
-| [`is_open()`](#fn-is-open)            | Return whether the virtual device is still open. |
-| [`sync()`](#fn-sync)                  | Emit a `SYN_REPORT` event.                       |
+| Function                                      | Description                                                   |
+| --------------------------------------------- | ------------------------------------------------------------- |
+| [`close()`](#fn-close)                        | Destroy and close the virtual device.                         |
+| [`create(spec?)`](#fn-create)                 | Create a virtual input device.                                |
+| [`emit(type, code, value)`](#fn-emit)         | Emit one raw input event.                                     |
+| [`fd()`](#fn-fd)                              | Get the file descriptor of the virtual device.                |
+| [`get_repeat()`](#fn-get-repeat)              | Get the current keyboard repeat rate from the virtual device. |
+| [`is_open()`](#fn-is-open)                    | Return whether the virtual device is still open.              |
+| [`set_repeat(delay, period)`](#fn-set-repeat) | Set the keyboard repeat rate on the virtual device.           |
+| [`sync()`](#fn-sync)                          | Emit a `SYN_REPORT` event.                                    |
 
 <a id="fn-close"></a>
 
@@ -56,10 +59,6 @@ Create a virtual input device.
 local UInput = evdev.uinput.create
 local ui = assert(UInput())
 
--- Give the system a moment to notice the new virtual device.
--- Replace this with your preferred sleep helper.
-os.execute("sleep 0.5")
-
 ui:emit(evdev.ecodes.EV_KEY, evdev.ecodes.KEY_A, 1)
 ui:emit(evdev.ecodes.EV_KEY, evdev.ecodes.KEY_A, 0)
 ui:sync()
@@ -91,10 +90,6 @@ Emit one raw input event.
 local UInput = evdev.uinput.create
 local ui = assert(UInput())
 
--- Give the system a moment to notice the new virtual device.
--- Replace this with your preferred sleep helper.
-os.execute("sleep 0.5")
-
 local EV_KEY = evdev.ecodes.EV_KEY
 ui:emit(EV_KEY, evdev.ecodes.KEY_A, 1)
 ui:emit(EV_KEY, evdev.ecodes.KEY_A, 0)
@@ -106,6 +101,47 @@ ui:emit(EV_REL, evdev.ecodes.REL_Y, 10)
 ui:sync()
 ```
 
+<a id="fn-fd"></a>
+
+### `fd()`
+
+Get the file descriptor of the virtual device.
+
+**Return**:
+
+- `fd` (`evdev.fd?`): Linux file descriptor.
+
+**Example**:
+
+```lua
+local UInput = evdev.uinput.create
+local ui = assert(UInput())
+print(ui:fd())
+```
+
+<a id="fn-get-repeat"></a>
+
+### `get_repeat()`
+
+Get the current keyboard repeat rate from the virtual device.
+
+**Return**:
+
+- `delay` (`integer?`): Repeat delay in milliseconds.
+- `period` (`integer?`): Repeat period in milliseconds.
+- `err` (`string?`): Error message on failure.
+
+**Example**:
+
+```lua
+local UInput = evdev.uinput.create
+local ui = assert(UInput())
+
+local delay, period, err = ui:get_repeat()
+assert(delay, err)
+print(delay, period)
+```
+
 <a id="fn-is-open"></a>
 
 ### `is_open()`
@@ -127,6 +163,32 @@ if ui:is_open() then
 end
 ```
 
+<a id="fn-set-repeat"></a>
+
+### `set_repeat(delay, period)`
+
+Set the keyboard repeat rate on the virtual device.
+
+**Parameters**:
+
+- `delay` (`integer`): Delay in milliseconds before key repeat starts.
+- `period` (`integer`): Period in milliseconds between repeated key events.
+
+**Return**:
+
+- `ok` (`true?`): `true` when the repeat rate is set successfully.
+- `err` (`string?`): Error message on failure.
+
+**Example**:
+
+```lua
+local UInput = evdev.uinput.create
+local ui = assert(UInput())
+
+-- Set repeat delay to 500ms, repeat period to 50ms
+ui:set_repeat(500, 50)
+```
+
 <a id="fn-sync"></a>
 
 ### `sync()`