@@ -11,9 +11,6 @@ local Selector = {}
1111--- Add a device to this selector.
1212---
1313--- ```lua
14- --- local Device = evdev.device.open
15- --- local Selector = evdev.selector.new
16- ---
1714--- local kb1 = assert(Device("/dev/input/event5"))
1815--- local kb2 = assert(Device("/dev/input/event10"))
1916--- local sel = Selector({ kb1 })
@@ -29,9 +26,6 @@ function Selector:add(device) end
2926--- Remove a device from this selector.
3027---
3128--- ```lua
32- --- local Device = evdev.device.open
33- --- local Selector = evdev.selector.new
34- ---
3529--- local kb1 = assert(Device("/dev/input/event5"))
3630--- local kb2 = assert(Device("/dev/input/event10"))
3731--- local sel = Selector({ kb1, kb2 })
@@ -47,9 +41,6 @@ function Selector:remove(device) end
4741--- Remove all devices from this selector.
4842---
4943--- ```lua
50- --- local Device = evdev.device.open
51- --- local Selector = evdev.selector.new
52- ---
5344--- local kb1 = assert(Device("/dev/input/event5"))
5445--- local kb2 = assert(Device("/dev/input/event10"))
5546--- local sel = Selector({ kb1, kb2 })
@@ -64,9 +55,6 @@ function Selector:clear() end
6455--- Wait until at least one registered device has input available.
6556---
6657--- ```lua
67- --- local Device = evdev.device.open
68- --- local Selector = evdev.selector.new
69- ---
7058--- local kb1 = assert(Device("/dev/input/event5"))
7159--- local kb2 = assert(Device("/dev/input/event10"))
7260--- local sel = Selector({ kb1, kb2 })
@@ -85,9 +73,6 @@ function Selector:poll() end
8573--- Return an iterator that yields events from registered devices.
8674---
8775--- ```lua
88- --- local Device = evdev.device.open
89- --- local Selector = evdev.selector.new
90- ---
9176--- local kb1 = assert(Device("/dev/input/event5"))
9277--- local kb2 = assert(Device("/dev/input/event10"))
9378--- local sel = Selector({ kb1, kb2 })
@@ -101,6 +86,26 @@ function Selector:poll() end
10186--- @nodiscard
10287function Selector :events () end
10388
89+ ---
90+ --- Monitor and read events from multiple input devices.
91+ ---
92+ --- ## Usage
93+ ---
94+ --- ```lua
95+ --- local evdev = require "evdev"
96+ ---
97+ --- local Device = evdev.device.open
98+ --- local Selector = evdev.selector.new
99+ ---
100+ --- local dev1 = assert(Device("/dev/input/eventX"))
101+ --- local dev2 = assert(Device("/dev/input/eventY"))
102+ --- local sel = Selector({ dev1, dev2 })
103+ ---
104+ --- for dev, ev in sel:events() do
105+ --- print(dev.name, ev.code, ev.value)
106+ --- end
107+ --- ```
108+ ---
104109--- @class evdev.selector
105110--- @overload fun ( devices ?: evdev.Device[] ):( sel : evdev.Selector )
106111local M = {}
@@ -109,10 +114,6 @@ local M = {}
109114--- Create a selector from an optional list of devices.
110115---
111116--- ```lua
112- --- local evdev = require "evdev"
113- --- local Device = evdev.device.open
114- --- local Selector = evdev.selector.new
115- ---
116117--- local kb1 = assert(Device("/dev/input/event5"))
117118--- local kb2 = assert(Device("/dev/input/event10"))
118119--- local sel = Selector({ kb1, kb2 })
0 commit comments