Merge pull request #605 from psychon/api-doc

Fix API documentation broken in eb8577a424
This commit is contained in:
Daniel Hahler 2015-12-23 18:14:07 +01:00
commit 9fec4f71bc
2 changed files with 4 additions and 0 deletions

View File

@ -122,6 +122,7 @@ end
--- Cut item list to return only current page. --- Cut item list to return only current page.
-- @tparam table all_items All items list. -- @tparam table all_items All items list.
-- @tparam str query Search query. -- @tparam str query Search query.
-- @tparam number scr Screen number
-- @return table List of items for current page. -- @return table List of items for current page.
local function get_current_page(all_items, query, scr) local function get_current_page(all_items, query, scr)
if not instance.prompt.width then if not instance.prompt.width then
@ -160,6 +161,7 @@ end
--- Update the menubar according to the command entered by user. --- Update the menubar according to the command entered by user.
-- @tparam str query Search query. -- @tparam str query Search query.
-- @tparam number scr Screen number
local function menulist_update(query, scr) local function menulist_update(query, scr)
query = query or "" query = query or ""
shownitems = {} shownitems = {}

View File

@ -256,6 +256,7 @@ end
--- Compute textbox width. --- Compute textbox width.
-- @tparam wibox.widget.textbox textbox Textbox instance. -- @tparam wibox.widget.textbox textbox Textbox instance.
-- @tparam number s Screen number
-- @treturn int Text width. -- @treturn int Text width.
function utils.compute_textbox_width(textbox, s) function utils.compute_textbox_width(textbox, s)
s = s or mouse.screen s = s or mouse.screen
@ -265,6 +266,7 @@ end
--- Compute text width. --- Compute text width.
-- @tparam str text Text. -- @tparam str text Text.
-- @tparam number s Screen number
-- @treturn int Text width. -- @treturn int Text width.
function utils.compute_text_width(text, s) function utils.compute_text_width(text, s)
return utils.compute_textbox_width(wibox.widget.textbox(awful_util.escape(text)), s) return utils.compute_textbox_width(wibox.widget.textbox(awful_util.escape(text)), s)