From 0f931517baf6bcc4501074abd33b5b874c8c2866 Mon Sep 17 00:00:00 2001 From: Qingping Hou Date: Sun, 25 Dec 2016 12:05:48 -0800 Subject: [PATCH] doc: fix document build --- frontend/optmath.lua | 16 +++++++++------- frontend/ui/widget/widget.lua | 5 ++++- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/frontend/optmath.lua b/frontend/optmath.lua index 4ef0a6e17..8584fd960 100644 --- a/frontend/optmath.lua +++ b/frontend/optmath.lua @@ -1,6 +1,6 @@ --[[-- Simple math helper functions -]]-- +]] local Math = {} @@ -49,9 +49,10 @@ end Returns the minimum element of a table. The optional argument func specifies a one-argument ordering function. -@tparam tab -@tparam func -]]-- +@tparam table tab +@tparam func func +@treturn dynamic minimum element of a table +]] function Math.tmin(tab, func) return tmin_max(tab, func, "min") end @@ -60,9 +61,10 @@ end Returns the maximum element of a table. The optional argument func specifies a one-argument ordering function. -@tparam tab -@tparam func -]]-- +@tparam table tab +@tparam func func +@treturn dynamic maximum element of a table +]] function Math.tmax(tab, func) return tmin_max(tab, func, "max") end diff --git a/frontend/ui/widget/widget.lua b/frontend/ui/widget/widget.lua index e0308a361..dde29d80d 100644 --- a/frontend/ui/widget/widget.lua +++ b/frontend/ui/widget/widget.lua @@ -11,6 +11,9 @@ rather than class variables. ]] local EventListener = require("ui/widget/eventlistener") + +--- Widget base class +-- @table Widget local Widget = EventListener:new() --[[-- @@ -61,7 +64,7 @@ end --[[-- 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. @int x x offset within the BlitBuffer @int y y offset within the BlitBuffer