From 3927dbcf0200f83547dc3e3e93065b53ff78ab24 Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Wed, 26 Sep 2018 10:37:59 +0200 Subject: [PATCH] Fix incorrect @name annotation in gears.string gears.string.xml_escape was annotated with "@name escape" and gears.string.xml_unescape was annotated with "@name unescape". Reference: https://github.com/awesomeWM/awesome/issues/2397#issuecomment-424630100 Signed-off-by: Uli Schlachter --- lib/gears/string.lua | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/gears/string.lua b/lib/gears/string.lua index 186082ff..6b6eb6b0 100644 --- a/lib/gears/string.lua +++ b/lib/gears/string.lua @@ -10,7 +10,7 @@ local xml_entity_names = { ["'"] = "'", ["\""] = """, ["<"] = "<", --- Escape a string from XML char. -- Useful to set raw text in textbox. -- @class function --- @name escape +-- @name xml_escape -- @param text Text to escape. -- @return Escape text. function gstring.xml_escape(text) @@ -21,7 +21,7 @@ local xml_entity_chars = { lt = "<", gt = ">", nbsp = " ", quot = "\"", apos = " amp = "&" }; --- Unescape a string from entities. -- @class function --- @name unescape +-- @name xml_unescape -- @param text Text to unescape. -- @return Unescaped text. function gstring.xml_unescape(text)