From 480b8b6477bb26a727ad3f0903caa80cb7e67e1b Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Fri, 9 Dec 2016 18:00:40 +0100 Subject: [PATCH 1/2] Remove @see tag.swap on awful.tag.object.swap The only other swap function is awful.tag.swap and that one is deprecated. Thus, it should not be linked to. Signed-off-by: Uli Schlachter --- lib/awful/tag.lua | 1 - 1 file changed, 1 deletion(-) diff --git a/lib/awful/tag.lua b/lib/awful/tag.lua index 05da7c16..254c1001 100644 --- a/lib/awful/tag.lua +++ b/lib/awful/tag.lua @@ -155,7 +155,6 @@ end --- Swap 2 tags -- @function tag.swap --- @see tag.swap -- @param tag2 The second tag -- @see client.swap function tag.object.swap(self, tag2) From 9a5092226a1b21b4dd550946c4c021ba31663d13 Mon Sep 17 00:00:00 2001 From: Uli Schlachter Date: Fri, 9 Dec 2016 18:03:03 +0100 Subject: [PATCH 2/2] awful.wibox.stretch: Spell out full replacement The function that is documented as awful.wibox.stretch is deprecated, because it was removed (that's not a deprecation, is it?!?). For the replacement, we used "@see stretch". However, LDoc was randomly resolving this reference to awful.wibar.stretch (good) or awful.wibox.stretch (bad; the see points to the element where it appears). Fix this by spelling out the "full name" of the function in the @see. Related-to: https://github.com/awesomeWM/awesome/issues/834 Signed-off-by: Uli Schlachter --- lib/awful/wibar.lua | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/awful/wibar.lua b/lib/awful/wibar.lua index 1df6fdbc..3ed9f0fa 100644 --- a/lib/awful/wibar.lua +++ b/lib/awful/wibar.lua @@ -262,7 +262,7 @@ end -- -- @deprecated awful.wibox.stretch -- @see awful.placement --- @see stretch +-- @see awful.wibar.stretch --- Create a new wibox and attach it to a screen edge. -- You can add also position key with value top, bottom, left or right.