1
0
mirror of https://gitlab.com/OpenMW/openmw.git synced 2025-03-30 07:21:12 +00:00

openmw.async wording and grammar.

This commit is contained in:
phenine 2024-09-06 01:07:29 +08:00
parent 3df183460d
commit c1165815df

View File

@ -1,5 +1,5 @@
--- ---
-- `openmw.async` contains timers and coroutine utils. All functions require -- `openmw.async` contains timers and coroutine utilities. All functions require
-- the package itself as a first argument. -- the package itself as a first argument.
-- @module async -- @module async
-- @usage local async = require('openmw.async') -- @usage local async = require('openmw.async')
@ -16,7 +16,7 @@
--- ---
-- Calls callback(arg) in `delay` simulation seconds. -- Calls callback(arg) in `delay` simulation seconds.
-- Callback must be registered in advance. -- The callback must be registered in advance.
-- @function [parent=#async] newSimulationTimer -- @function [parent=#async] newSimulationTimer
-- @param self -- @param self
-- @param #number delay -- @param #number delay
@ -25,7 +25,7 @@
--- ---
-- Calls callback(arg) in `delay` game seconds. -- Calls callback(arg) in `delay` game seconds.
-- Callback must be registered in advance. -- The callback must be registered in advance.
-- @function [parent=#async] newGameTimer -- @function [parent=#async] newGameTimer
-- @param self -- @param self
-- @param #number delay -- @param #number delay
@ -49,7 +49,7 @@
-- @param #function func -- @param #function func
--- ---
-- Wraps Lua function with `Callback` object that can be used in async API calls. -- Wraps a Lua function with a `Callback` object that can be used in async API calls.
-- @function [parent=#async] callback -- @function [parent=#async] callback
-- @param self -- @param self
-- @param #function func -- @param #function func