Skip to content

Commit e69afd2

Browse files
committed
Update documentation again
1 parent ffceb21 commit e69afd2

1 file changed

Lines changed: 22 additions & 22 deletions

File tree

ScreenManager.lua

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ end
144144
-- ------------------------------------------------
145145

146146
---
147-
-- Reroute the directorydropped callback to the currently active screen.
147+
-- Reroutes the directorydropped callback to the currently active screen.
148148
-- @param path (string) The full platform-dependent path to the directory.
149149
-- It can be used as an argument to love.filesystem.mount,
150150
-- in order to gain read access to the directory with
@@ -155,7 +155,7 @@ function ScreenManager.directorydropped( path )
155155
end
156156

157157
---
158-
-- Reroute the draw callback to all screens on the stack.
158+
-- Reroutes the draw callback to all screens on the stack.
159159
-- Screens that are higher on the stack will overlay screens that are below
160160
-- them.
161161
--
@@ -166,7 +166,7 @@ function ScreenManager.draw()
166166
end
167167

168168
---
169-
-- Reroute the filedropped callback to the currently active screen.
169+
-- Reroutes the filedropped callback to the currently active screen.
170170
-- @param file (File) The unopened File object representing the file that was
171171
-- dropped.
172172
--
@@ -175,7 +175,7 @@ function ScreenManager.filedropped( file )
175175
end
176176

177177
---
178-
-- Reroute the focus callback to all screens on the stack.
178+
-- Reroutes the focus callback to all screens on the stack.
179179
-- @param focus (boolean) True if the window gains focus, false if it loses focus.
180180
--
181181
function ScreenManager.focus( focus )
@@ -185,7 +185,7 @@ function ScreenManager.focus( focus )
185185
end
186186

187187
---
188-
-- Reroute the keypressed callback to the currently active screen.
188+
-- Reroutes the keypressed callback to the currently active screen.
189189
-- @param key (KeyConstant) Character of the pressed key.
190190
-- @param scancode (Scancode) The scancode representing the pressed key.
191191
-- @param isrepeat (boolean) Whether this keypress event is a repeat. The
@@ -197,7 +197,7 @@ function ScreenManager.keypressed( key, scancode, isrepeat )
197197
end
198198

199199
---
200-
-- Reroute the keyreleased callback to the currently active screen.
200+
-- Reroutes the keyreleased callback to the currently active screen.
201201
-- @param key (KeyConstant) Character of the released key.
202202
-- @param scancode (Scancode) The scancode representing the released key.
203203
--
@@ -206,23 +206,23 @@ function ScreenManager.keyreleased( key, scancode )
206206
end
207207

208208
---
209-
-- Reroute the lowmemory callback to the currently active screen.
209+
-- Reroutes the lowmemory callback to the currently active screen.
210210
-- mobile devices.
211211
--
212212
function ScreenManager.lowmemory()
213213
ScreenManager.peek():lowmemory();
214214
end
215215

216216
---
217-
-- Reroute the mousefocus callback to the currently active screen.
217+
-- Reroutes the mousefocus callback to the currently active screen.
218218
-- @param focus (boolean) Wether the window has mouse focus or not.
219219
--
220220
function ScreenManager.mousefocus( focus )
221221
ScreenManager.peek():mousefocus( focus );
222222
end
223223

224224
---
225-
-- Reroute the mousemoved callback to the currently active screen.
225+
-- Reroutes the mousemoved callback to the currently active screen.
226226
-- @param x (number) Mouse x position.
227227
-- @param y (number) Mouse y position.
228228
-- @param dx (number) The amount moved along the x-axis since the last time
@@ -235,7 +235,7 @@ function ScreenManager.mousemoved( x, y, dx, dy )
235235
end
236236

237237
---
238-
-- Reroute the mousepressed callback to the currently active screen.
238+
-- Reroutes the mousepressed callback to the currently active screen.
239239
-- @param x (number) Mouse x position, in pixels.
240240
-- @param y (number) Mouse y position, in pixels.
241241
-- @param button (number) The button index that was pressed. 1 is the primary
@@ -250,7 +250,7 @@ function ScreenManager.mousepressed( x, y, button, istouch )
250250
end
251251

252252
---
253-
-- Reroute the mousereleased callback to the currently active screen.
253+
-- Reroutes the mousereleased callback to the currently active screen.
254254
-- @param x (number) Mouse x position, in pixels.
255255
-- @param y (number) Mouse y position, in pixels.
256256
-- @param button (number) The button index that was released. 1 is the primary
@@ -265,15 +265,15 @@ function ScreenManager.mousereleased( x, y, button, istouch )
265265
end
266266

267267
---
268-
-- Reroute the quit callback to the currently active screen.
268+
-- Reroutes the quit callback to the currently active screen.
269269
-- @return quit (boolean) Abort quitting. If true, do not close the game.
270270
--
271271
function ScreenManager.quit()
272272
ScreenManager.peek():quit();
273273
end
274274

275275
---
276-
-- Reroute the resize callback to all screens on the stack.
276+
-- Reroutes the resize callback to all screens on the stack.
277277
-- @param w (number) The new width, in pixels.
278278
-- @param h (number) The new height, in pixels.
279279
--
@@ -284,7 +284,7 @@ function ScreenManager.resize( w, h )
284284
end
285285

286286
---
287-
-- Reroute the textedited callback to the currently active screen.
287+
-- Reroutes the textedited callback to the currently active screen.
288288
-- @param text (string) The UTF-8 encoded unicode candidate text.
289289
-- @param start (number) The start cursor of the selected candidate text.
290290
-- @param length (number) The length of the selected candidate text. May be 0.
@@ -294,15 +294,15 @@ function ScreenManager.textedited( text, start, length )
294294
end
295295

296296
---
297-
-- Reroute the textinput callback to the currently active screen.
297+
-- Reroutes the textinput callback to the currently active screen.
298298
-- @param input (string) The UTF-8 encoded unicode text.
299299
--
300300
function ScreenManager.textinput( input )
301301
ScreenManager.peek():textinput( input );
302302
end
303303

304304
---
305-
-- Reroute the threaderror callback to all screens.
305+
-- Reroutes the threaderror callback to all screens.
306306
-- @param thread (Thread) The thread which produced the error.
307307
-- @param errorstr (string) The error message.
308308
--
@@ -314,7 +314,7 @@ end
314314

315315

316316
---
317-
-- Reroute the touchmoved callback to the currently active screen.
317+
-- Reroutes the touchmoved callback to the currently active screen.
318318
-- @param id (light userdata) The identifier for the touch press.
319319
-- @param x (number) The x-axis position of the touch press inside the
320320
-- window, in pixels.
@@ -333,7 +333,7 @@ function ScreenManager.touchmoved( id, x, y, dx, dy, pressure )
333333
end
334334

335335
---
336-
-- Reroute the touchpressed callback to the currently active screen.
336+
-- Reroutes the touchpressed callback to the currently active screen.
337337
-- @param id (light userdata) The identifier for the touch press.
338338
-- @param x (number) The x-axis position of the touch press inside the
339339
-- window, in pixels.
@@ -352,7 +352,7 @@ function ScreenManager.touchpressed( id, x, y, dx, dy, pressure )
352352
end
353353

354354
---
355-
-- Reroute the touchreleased callback to the currently active screen.
355+
-- Reroutes the touchreleased callback to the currently active screen.
356356
-- @param id (light userdata) The identifier for the touch press.
357357
-- @param x (number) The x-axis position of the touch press inside the
358358
-- window, in pixels.
@@ -371,7 +371,7 @@ function ScreenManager.touchreleased( id, x, y, dx, dy, pressure )
371371
end
372372

373373
---
374-
-- Reroute the update callback to all screens.
374+
-- Reroutes the update callback to all screens.
375375
-- @param dt (number) Time since the last update in seconds.
376376
--
377377
function ScreenManager.update( dt )
@@ -381,7 +381,7 @@ function ScreenManager.update( dt )
381381
end
382382

383383
---
384-
-- Reroute the visible callback to all screens.
384+
-- Reroutes the visible callback to all screens.
385385
-- @param visible (boolean) True if the window is visible, false if it isn't.
386386
--
387387
function ScreenManager.visible( visible )
@@ -391,7 +391,7 @@ function ScreenManager.visible( visible )
391391
end
392392

393393
---
394-
-- Reroute the wheelmoved callback to the currently active screen.
394+
-- Reroutes the wheelmoved callback to the currently active screen.
395395
-- @param x (number) Amount of horizontal mouse wheel movement. Positive values
396396
-- indicate movement to the right.
397397
-- @param y (number) Amount of vertical mouse wheel movement. Positive values

0 commit comments

Comments
 (0)