Fix doc for textbox:set_markup

2014-03-24 01:01:41 +01:00 · 2014-03-24 01:01:41 +01:00 · 29d1b473f8
parent a4d42048c2
commit 29d1b473f8
1 changed files with 4 additions and 2 deletions
--- a/lib/wibox/widget/textbox.lua.in
+++ b/lib/wibox/widget/textbox.lua.in
@ -53,8 +53,10 @@ function textbox:fit(width, height)
    return logical.width, logical.height
 end

--- Set a textbox' text.
-- @param text The text to set. This can contain pango markup (e.g. <b>bold</b>)
+--- Set the text of the textbox (with Pango markup).
+-- @param text The text to set. This can contain pango markup (e.g.
+-- <pre><b>bold</b></pre>). You can use awful.util.escape to escape
+-- parts of it.
 function textbox:set_markup(text)
    local attr, parsed = Pango.parse_markup(text, -1, 0)
    -- In case of error, attr is false and parsed is an error message