Skip to content

Commit 1df52b5

Browse files
author
pinnacle-comp
committed
1 parent 654c472 commit 1df52b5

22 files changed

Lines changed: 133 additions & 129 deletions

main/classes/pinnacle.debug.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ red rectangles drawn where the damage is.
2828
#### Parameters
2929

3030
`set`
31-
| <code>boolean</code>
31+
- <code>boolean</code>
3232

3333

3434

@@ -63,7 +63,7 @@ drawn.
6363
#### Parameters
6464

6565
`set`
66-
| <code>boolean</code>
66+
- <code>boolean</code>
6767

6868

6969

@@ -95,7 +95,7 @@ Sets cursor plane scanout.
9595
#### Parameters
9696

9797
`set`
98-
| <code>boolean</code>
98+
- <code>boolean</code>
9999

100100

101101

@@ -123,7 +123,7 @@ Enables or disables process spawning setting up pipes to give fds to the config.
123123
#### Parameters
124124

125125
`set`
126-
| <code>boolean</code>
126+
- <code>boolean</code>
127127

128128

129129

main/classes/pinnacle.input.libinput.DeviceHandle.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ This only affects devices with touch capability.
123123
#### Parameters
124124

125125
`output` - The output to map the device's input to
126-
| <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code>
126+
- <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code>
127127

128128

129129

@@ -151,7 +151,7 @@ This only affects devices with touch capability.
151151
#### Parameters
152152

153153
`region` - The region in the global space to map input to
154-
| <code>{ x: integer, y: integer, width: integer, height: integer }</code>
154+
- <code>{ x: integer, y: integer, width: integer, height: integer }</code>
155155

156156

157157

@@ -170,7 +170,7 @@ Sets this device's acceleration profile.
170170
#### Parameters
171171

172172
`accel_profile`
173-
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.AccelProfile">pinnacle.input.libinput.AccelProfile</a></code>
173+
- <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.AccelProfile">pinnacle.input.libinput.AccelProfile</a></code>
174174

175175

176176

@@ -187,7 +187,7 @@ Sets this device's acceleration speed.
187187
#### Parameters
188188

189189
`accel_speed`
190-
| <code>number</code>
190+
- <code>number</code>
191191

192192

193193

@@ -204,7 +204,7 @@ Sets this device's calibration matrix.
204204
#### Parameters
205205

206206
`calibration_matrix` - The calibration matrix as an array of 6 floats.
207-
| <code>number[]</code>
207+
- <code>number[]</code>
208208

209209

210210

@@ -221,7 +221,7 @@ Sets this device's click method.
221221
#### Parameters
222222

223223
`click_method`
224-
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.ClickMethod">pinnacle.input.libinput.ClickMethod</a></code>
224+
- <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.ClickMethod">pinnacle.input.libinput.ClickMethod</a></code>
225225

226226

227227

@@ -238,7 +238,7 @@ Sets whether or not this device is disabled while typing.
238238
#### Parameters
239239

240240
`disable_while_typing`
241-
| <code>boolean</code>
241+
- <code>boolean</code>
242242

243243

244244

@@ -255,7 +255,7 @@ Sets this device to left-handed or not.
255255
#### Parameters
256256

257257
`left_handed`
258-
| <code>boolean</code>
258+
- <code>boolean</code>
259259

260260

261261

@@ -272,7 +272,7 @@ Sets whether or not middle emulation is enabled.
272272
#### Parameters
273273

274274
`middle_emulation`
275-
| <code>boolean</code>
275+
- <code>boolean</code>
276276

277277

278278

@@ -289,7 +289,7 @@ Sets this device's rotation angle.
289289
#### Parameters
290290

291291
`rotation_angle`
292-
| <code>integer</code>
292+
- <code>integer</code>
293293

294294

295295

@@ -306,7 +306,7 @@ Sets this device's scroll button.
306306
#### Parameters
307307

308308
`scroll_button`
309-
| <code>integer</code>
309+
- <code>integer</code>
310310

311311

312312

@@ -323,7 +323,7 @@ Sets whether or not the scroll button locks on this device.
323323
#### Parameters
324324

325325
`scroll_button_lock`
326-
| <code>boolean</code>
326+
- <code>boolean</code>
327327

328328

329329

@@ -340,7 +340,7 @@ Sets this device's scroll method.
340340
#### Parameters
341341

342342
`scroll_method`
343-
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.ScrollMethod">pinnacle.input.libinput.ScrollMethod</a></code>
343+
- <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.ScrollMethod">pinnacle.input.libinput.ScrollMethod</a></code>
344344

345345

346346

@@ -357,7 +357,7 @@ Enables or disables natural scroll on this device.
357357
#### Parameters
358358

359359
`natural_scroll`
360-
| <code>boolean</code>
360+
- <code>boolean</code>
361361

362362

363363

@@ -374,7 +374,7 @@ Sets this device's tap button map.
374374
#### Parameters
375375

376376
`tap_button_map`
377-
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.TapButtonMap">pinnacle.input.libinput.TapButtonMap</a></code>
377+
- <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.TapButtonMap">pinnacle.input.libinput.TapButtonMap</a></code>
378378

379379

380380

@@ -391,7 +391,7 @@ Enables or disables tap dragging on this device.
391391
#### Parameters
392392

393393
`tap_drag`
394-
| <code>boolean</code>
394+
- <code>boolean</code>
395395

396396

397397

@@ -408,7 +408,7 @@ Sets whether or not tap dragging locks on this device.
408408
#### Parameters
409409

410410
`tap_drag_lock`
411-
| <code>boolean</code>
411+
- <code>boolean</code>
412412

413413

414414

@@ -425,7 +425,7 @@ Enables or disables tap-to-click on this device.
425425
#### Parameters
426426

427427
`tap`
428-
| <code>boolean</code>
428+
- <code>boolean</code>
429429

430430

431431

@@ -442,7 +442,7 @@ Sets this device's send events mode.
442442
#### Parameters
443443

444444
`send_events_mode`
445-
| <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.SendEventsMode">pinnacle.input.libinput.SendEventsMode</a></code>
445+
- <code><a href="/lua-reference/main/enums/pinnacle.input.libinput.SendEventsMode">pinnacle.input.libinput.SendEventsMode</a></code>
446446

447447

448448

main/classes/pinnacle.input.libinput.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ all devices that will be connected in the future.
3939
#### Parameters
4040

4141
`for_each`
42-
| <code>fun(device: <a href="/lua-reference/main/classes/pinnacle.input.libinput.DeviceHandle">pinnacle.input.libinput.DeviceHandle</a>)</code>
42+
- <code>fun(device: <a href="/lua-reference/main/classes/pinnacle.input.libinput.DeviceHandle">pinnacle.input.libinput.DeviceHandle</a>)</code>
4343

4444

4545

main/classes/pinnacle.input.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,13 @@ end)
7474
#### Parameters
7575

7676
`mods` - The modifiers that need to be held down for the bind to trigger
77-
| <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code><br>
77+
- <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code><br>
7878
`key` - The key used to trigger the bind
79-
| <code><a href="/lua-reference/main/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string</code><br>
79+
- <code><a href="/lua-reference/main/enums/pinnacle.input.Key">pinnacle.input.Key</a> | string</code><br>
8080
`on_press` - The function to run when the bind is triggered
81-
| <code>fun()</code><br>
81+
- <code>fun()</code><br>
8282
`bind_info` - An optional group and description that is displayed in the bind overlay.
83-
| <code>{ group?: string, description?: string }</code>
83+
- <code>{ group?: string, description?: string }</code>
8484

8585

8686

@@ -127,13 +127,13 @@ end)
127127
#### Parameters
128128

129129
`mods` - The modifiers that need to be held down for the bind to trigger
130-
| <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code><br>
130+
- <code><a href="/lua-reference/main/enums/pinnacle.input.Mod">pinnacle.input.Mod</a>[]</code><br>
131131
`button` - The mouse button used to trigger the bind
132-
| <code><a href="/lua-reference/main/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a></code><br>
132+
- <code><a href="/lua-reference/main/enums/pinnacle.input.MouseButton">pinnacle.input.MouseButton</a></code><br>
133133
`on_press` - The function to run when the bind is triggered
134-
| <code>fun()</code><br>
134+
- <code>fun()</code><br>
135135
`bind_info` - An optional group and description that will be displayed in the bind overlay.
136-
| <code>{ group?: string, description?: string }</code>
136+
- <code>{ group?: string, description?: string }</code>
137137

138138

139139

@@ -150,7 +150,7 @@ Enters the bind layer `layer`, or the default layer if `layer` is nil.
150150
#### Parameters
151151

152152
`layer` - The bind layer.
153-
| <code>string</code>
153+
- <code>string</code>
154154

155155

156156

@@ -194,7 +194,7 @@ Input.set_xkb_config({
194194
#### Parameters
195195

196196
`xkb_config` - The new xkbconfig
197-
| <code><a href="/lua-reference/main/classes/pinnacle.input.XkbConfig">pinnacle.input.XkbConfig</a></code>
197+
- <code><a href="/lua-reference/main/classes/pinnacle.input.XkbConfig">pinnacle.input.XkbConfig</a></code>
198198

199199

200200

@@ -216,9 +216,9 @@ Input.set_repeat_rate(100, 1000) -- Key must be held down for 1 second, then rep
216216
#### Parameters
217217

218218
`rate` - The time between repeats in milliseconds
219-
| <code>integer</code><br>
219+
- <code>integer</code><br>
220220
`delay` - The duration a key needs to be held down before repeating starts in milliseconds
221-
| <code>integer</code>
221+
- <code>integer</code>
222222

223223

224224

@@ -243,7 +243,7 @@ Input.set_xkb_keymap(io.open("/path/to/keymap.xkb"):read("*a"))
243243
#### Parameters
244244

245245
`keymap` - The keymap to set.
246-
| <code>string</code>
246+
- <code>string</code>
247247

248248

249249

@@ -284,7 +284,7 @@ Fails if the index is out of bounds.
284284
#### Parameters
285285

286286
`index` - The index of the layout to switch to.
287-
| <code>integer</code>
287+
- <code>integer</code>
288288

289289

290290

@@ -304,7 +304,7 @@ This allows you to set it at runtime.
304304
#### Parameters
305305

306306
`theme` - The name of the xcursor theme.
307-
| <code>string</code>
307+
- <code>string</code>
308308

309309

310310

@@ -324,7 +324,7 @@ This allows you to set it at runtime.
324324
#### Parameters
325325

326326
`size` - The new size of the cursor.
327-
| <code>integer</code>
327+
- <code>integer</code>
328328

329329

330330

@@ -358,7 +358,7 @@ Input.connect_signal({
358358
#### Parameters
359359

360360
`signals` - The signal you want to connect to
361-
| <code><a href="/lua-reference/main/classes/pinnacle.input.InputSignal">pinnacle.input.InputSignal</a></code>
361+
- <code><a href="/lua-reference/main/classes/pinnacle.input.InputSignal">pinnacle.input.InputSignal</a></code>
362362

363363

364364

main/classes/pinnacle.layout.LayoutRequester.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Causes the compositor to emit a layout request.
2828
#### Parameters
2929

3030
`output` - The output to layout, or `nil` for the focused output.
31-
| <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code>
31+
- <code><a href="/lua-reference/main/classes/pinnacle.output.OutputHandle">pinnacle.output.OutputHandle</a></code>
3232

3333

3434

main/classes/pinnacle.layout.builtin.Cycle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Cycles the layout forward for the given tag.
4141
#### Parameters
4242

4343
`tag` - The tag to cycle the layout for.
44-
| <code><a href="/lua-reference/main/classes/pinnacle.tag.TagHandle">pinnacle.tag.TagHandle</a></code>
44+
- <code><a href="/lua-reference/main/classes/pinnacle.tag.TagHandle">pinnacle.tag.TagHandle</a></code>
4545

4646

4747

@@ -58,7 +58,7 @@ Cycles the layout backward for the given tag.
5858
#### Parameters
5959

6060
`tag` - The tag to cycle the layout for.
61-
| <code><a href="/lua-reference/main/classes/pinnacle.tag.TagHandle">pinnacle.tag.TagHandle</a></code>
61+
- <code><a href="/lua-reference/main/classes/pinnacle.tag.TagHandle">pinnacle.tag.TagHandle</a></code>
6262

6363

6464

@@ -77,7 +77,7 @@ Gets the current layout generator for the given tag.
7777
#### Parameters
7878

7979
`tag` - The tag to get a layout for.
80-
| <code><a href="/lua-reference/main/classes/pinnacle.tag.TagHandle">pinnacle.tag.TagHandle</a></code>
80+
- <code><a href="/lua-reference/main/classes/pinnacle.tag.TagHandle">pinnacle.tag.TagHandle</a></code>
8181

8282

8383

0 commit comments

Comments
 (0)