From 65ad83ac30841a73cdd5129b02540ff9872c0e0e Mon Sep 17 00:00:00 2001
From: Daniel Hahler <git@thequod.de>
Date: Thu, 26 Feb 2015 16:05:47 +0100
Subject: [PATCH] docs: ignore awful/widget/init.lua, not common

---
 docs/config.ld.in              |  2 +-
 lib/awful/widget/common.lua.in | 15 ++++++++++++++-
 lib/awful/widget/init.lua.in   |  2 +-
 3 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/docs/config.ld.in b/docs/config.ld.in
index 5f306938..10804fc2 100644
--- a/docs/config.ld.in
+++ b/docs/config.ld.in
@@ -47,7 +47,7 @@ file = {
         '../lib/awful/startup_notification.lua',
 
         -- Ignore some parts of the widget library
-        '../lib/awful/widget/common.lua',
+        '../lib/awful/widget/init.lua',
 
         -- exclude layout, but we need an extra bit of documentation elsewhere.
         '../lib/awful/layout/suit/'
diff --git a/lib/awful/widget/common.lua.in b/lib/awful/widget/common.lua.in
index fee36f61..e28f5775 100644
--- a/lib/awful/widget/common.lua.in
+++ b/lib/awful/widget/common.lua.in
@@ -2,6 +2,7 @@
 -- @author Julien Danjou &lt;julien@danjou.info&gt;
 -- @copyright 2008-2009 Julien Danjou
 -- @release @AWESOME_VERSION@
+-- @classmod awful.widget.common
 ---------------------------------------------------------------------------
 
 -- Grab environment we need
@@ -20,6 +21,10 @@ local textbox = require("wibox.widget.textbox")
 --- Common utilities for awful widgets
 local common = {}
 
+--- Common method to create buttons.
+-- @tab buttons
+-- @param object
+-- @treturn table
 function common.create_buttons(buttons, object)
     if buttons then
         local btns = {}
@@ -38,6 +43,14 @@ function common.create_buttons(buttons, object)
     end
 end
 
+--- Common update method.
+-- @param w The widget.
+-- @tab buttons
+-- @func label Function to generate label parameters from an object.
+--   The function gets passed an object from `objects`, and
+--   has to return `text`, `bg`, `bg_image`, `icon`.
+-- @tab data Current data/cache, indexed by objects.
+-- @tab objects Objects to be displayed / updated.
 function common.list_update(w, buttons, label, data, objects)
     -- update the widgets, creating them if needed
     w:reset()
@@ -75,7 +88,7 @@ function common.list_update(w, buttons, label, data, objects)
         end
 
         local text, bg, bg_image, icon = label(o)
-        -- The text might be invalid, so use pcall
+        -- The text might be invalid, so use pcall.
         if text == nil or text == "" then
             m:set_margins(0)
         else
diff --git a/lib/awful/widget/init.lua.in b/lib/awful/widget/init.lua.in
index 96ec4615..0d61b94c 100644
--- a/lib/awful/widget/init.lua.in
+++ b/lib/awful/widget/init.lua.in
@@ -4,7 +4,7 @@
 -- @author Julien Danjou &lt;julien@danjou.info&gt;
 -- @copyright 2008-2009 Julien Danjou
 -- @release @AWESOME_VERSION@
--- @module awful.widget
+-- @classmod awful.widget
 ---------------------------------------------------------------------------
 
 return