Merge pull request #2116 from Elv13/cleanup_doc

Cleanup doc

docs/config.ld

@@ -85,7 +85,14 @@ file = {
     '../spawn.c',
     '../xkb.c',
     '../common/luaobject.c',
-    '../objects/',
+    '../objects/button.c',
+    '../objects/client.c',
+    '../objects/drawable.c',
+    '../objects/key.c',
+    '../objects/screen.c',
+    '../objects/tag.c',
+    '../objects/window.c',
+
     -- LUA libraries
     '../lib/',
     -- Auto generated scripts
@@ -110,8 +117,16 @@ file = {
         -- Ignore some parts of the widget library
         '../lib/awful/widget/init.lua',
 
-        -- Ignore the drawing window, users should only care about wiboxes
-        '../objects/drawin.c',
+        -- Deprecated classes for one years or more don't deserve entries
+        -- in the index
+        '../lib/awful/widget/graph.lua',
+        '../lib/awful/widget/progressbar.lua',
+        '../lib/wibox/layout/constraint.lua',
+        '../lib/wibox/layout/margin.lua',
+        '../lib/wibox/layout/mirror.lua',
+        '../lib/wibox/layout/rotate.lua',
+        '../lib/wibox/layout/scroll.lua',
+        '../lib/wibox/widget/background.lua',
     }
 }
 

lib/awful/hotkeys_popup/keys/firefox.lua

@@ -3,7 +3,7 @@
 --
 -- @author Jonathan <jonathan@tinypulse.com>
 -- @copyright 2017 Jonathan
--- @module awful.hotkeys_popup.keys.firefox
+-- @submodule awful.hotkeys_popup
 ---------------------------------------------------------------------------
 
 local hotkeys_popup = require("awful.hotkeys_popup.widget")

lib/awful/hotkeys_popup/keys/init.lua

@@ -3,7 +3,7 @@
 --
 -- @author Yauheni Kirylau <yawghen@gmail.com>
 -- @copyright 2014-2015 Yauheni Kirylau
--- @module awful.hotkeys_popup.keys
+-- @submodule awful.hotkeys_popup
 ---------------------------------------------------------------------------
 
 

lib/awful/hotkeys_popup/keys/qutebrowser.lua

@@ -3,7 +3,7 @@
 --
 -- @author Simon Désaulniers sim.desaulniers@gmail.com
 -- @copyright 2017 Simon Désaulniers
--- @module awful.hotkeys_popup.keys.qutebrowser
+-- @submodule awful.hotkeys_popup
 ---------------------------------------------------------------------------
 
 local hotkeys_popup = require("awful.hotkeys_popup.widget")

lib/awful/hotkeys_popup/keys/tmux.lua

@@ -3,7 +3,7 @@
 --
 -- @author nahsi nashi@airmail.cc
 -- @copyright 2017 nahsi
--- @module awful.hotkeys_popup.keys.tmux
+-- @submodule  awful.hotkeys_popup
 ---------------------------------------------------------------------------
 
 local hotkeys_popup = require("awful.hotkeys_popup.widget")

lib/awful/hotkeys_popup/keys/vim.lua

@@ -3,7 +3,7 @@
 --
 -- @author Yauheni Kirylau <yawghen@gmail.com>
 -- @copyright 2014-2015 Yauheni Kirylau
--- @module awful.hotkeys_popup.keys.vim
+-- @submodule awful.hotkeys_popup
 ---------------------------------------------------------------------------
 
 local hotkeys_popup = require("awful.hotkeys_popup.widget")