doc: fix document build

pull/2454/head
Qingping Hou 7 years ago
parent d4df82182c
commit 0f931517ba

@ -1,6 +1,6 @@
--[[-- --[[--
Simple math helper functions Simple math helper functions
]]-- ]]
local Math = {} local Math = {}
@ -49,9 +49,10 @@ end
Returns the minimum element of a table. Returns the minimum element of a table.
The optional argument func specifies a one-argument ordering function. The optional argument func specifies a one-argument ordering function.
@tparam tab @tparam table tab
@tparam func @tparam func func
]]-- @treturn dynamic minimum element of a table
]]
function Math.tmin(tab, func) function Math.tmin(tab, func)
return tmin_max(tab, func, "min") return tmin_max(tab, func, "min")
end end
@ -60,9 +61,10 @@ end
Returns the maximum element of a table. Returns the maximum element of a table.
The optional argument func specifies a one-argument ordering function. The optional argument func specifies a one-argument ordering function.
@tparam tab @tparam table tab
@tparam func @tparam func func
]]-- @treturn dynamic maximum element of a table
]]
function Math.tmax(tab, func) function Math.tmax(tab, func)
return tmin_max(tab, func, "max") return tmin_max(tab, func, "max")
end end

@ -11,6 +11,9 @@ rather than class variables.
]] ]]
local EventListener = require("ui/widget/eventlistener") local EventListener = require("ui/widget/eventlistener")
--- Widget base class
-- @table Widget
local Widget = EventListener:new() local Widget = EventListener:new()
--[[-- --[[--
@ -61,7 +64,7 @@ end
--[[-- --[[--
Paint widget to a BlitBuffer. Paint widget to a BlitBuffer.
@tparam BlitBuffer BlitBuffer to paint to. If it's the screen BlitBuffer, then @tparam BlitBuffer bb BlitBuffer to paint to. If it's the screen BlitBuffer, then
widget will show up on screen refresh. widget will show up on screen refresh.
@int x x offset within the BlitBuffer @int x x offset within the BlitBuffer
@int y y offset within the BlitBuffer @int y y offset within the BlitBuffer

Loading…
Cancel
Save