From 9d0c2200b275357fe24dd79248e71c65870b0a1c Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Thu, 6 Jun 2019 02:40:00 -0400 Subject: [PATCH] doc: Add a section for the important classes. The choice is very subjective, but at least they stand out. --- docs/config.ld | 1 + lib/awful/keygrabber.lua | 3 +-- lib/gears/timer.lua | 2 +- lib/naughty/notification.lua | 2 +- lib/wibox/init.lua | 2 +- mouse.c | 2 +- mousegrabber.c | 2 +- objects/button.c | 2 +- objects/client.c | 2 +- objects/drawable.c | 2 +- objects/key.c | 2 +- objects/screen.c | 2 +- objects/tag.c | 2 +- root.c | 2 +- 14 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/config.ld b/docs/config.ld index 8088b740..17214014 100644 --- a/docs/config.ld +++ b/docs/config.ld @@ -93,6 +93,7 @@ sort_modules=true new_type("widgetmod" , "Widgets" , true) new_type("containermod", "Widget containers", true) new_type("layoutmod" , "Widget layouts" , true) +new_type("coreclassmod", "Core components" , true) file = { -- C parts of libraries diff --git a/lib/awful/keygrabber.lua b/lib/awful/keygrabber.lua index 928a6ecb..82e1038e 100644 --- a/lib/awful/keygrabber.lua +++ b/lib/awful/keygrabber.lua @@ -60,7 +60,7 @@ -- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @copyright 2012 dodo -- @copyright 2017 Emmanuel Lepage Vallee --- @classmod awful.keygrabber +-- @coreclassmod awful.keygrabber --------------------------------------------------------------------------- local ipairs = ipairs @@ -731,7 +731,6 @@ end -- @return the given callback `g`. -- -- @deprecated awful.keygrabber.run --- @see keygrabber.run --- A lower level API to interact with the keygrabber directly. -- diff --git a/lib/gears/timer.lua b/lib/gears/timer.lua index bcc692cf..a955472b 100644 --- a/lib/gears/timer.lua +++ b/lib/gears/timer.lua @@ -46,7 +46,7 @@ -- -- @author Uli Schlachter -- @copyright 2014 Uli Schlachter --- @classmod gears.timer +-- @coreclassmod gears.timer --------------------------------------------------------------------------- local capi = { awesome = awesome } diff --git a/lib/naughty/notification.lua b/lib/naughty/notification.lua index 792a4ae9..4be3b164 100644 --- a/lib/naughty/notification.lua +++ b/lib/naughty/notification.lua @@ -13,7 +13,7 @@ -- @author Emmanuel Lepage Vallee -- @copyright 2008 koniu -- @copyright 2017 Emmanuel Lepage Vallee --- @classmod naughty.notification +-- @coreclassmod naughty.notification --------------------------------------------------------------------------- local gobject = require("gears.object") local gtable = require("gears.table") diff --git a/lib/wibox/init.lua b/lib/wibox/init.lua index 383cf50f..0e59e9eb 100644 --- a/lib/wibox/init.lua +++ b/lib/wibox/init.lua @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- -- @author Uli Schlachter -- @copyright 2010 Uli Schlachter --- @classmod wibox +-- @coreclassmod wibox --------------------------------------------------------------------------- local capi = { diff --git a/mouse.c b/mouse.c index d4c11bba..3f2ccf89 100644 --- a/mouse.c +++ b/mouse.c @@ -57,7 +57,7 @@ * * @author Julien Danjou <julien@danjou.info> * @copyright 2008-2009 Julien Danjou - * @module mouse + * @coreclassmod mouse */ #include "mouse.h" diff --git a/mousegrabber.c b/mousegrabber.c index 282c9d22..5efe7205 100644 --- a/mousegrabber.c +++ b/mousegrabber.c @@ -22,7 +22,7 @@ /** awesome mousegrabber API * @author Julien Danjou <julien@danjou.info> * @copyright 2008-2009 Julien Danjou - * @module mousegrabber + * @coreclassmod mousegrabber */ #include "mousegrabber.h" diff --git a/objects/button.c b/objects/button.c index 846ed7d4..9670b470 100644 --- a/objects/button.c +++ b/objects/button.c @@ -30,7 +30,7 @@ * * @author Julien Danjou <julien@danjou.info> * @copyright 2008-2009 Julien Danjou - * @classmod button + * @coreclassmod button */ #include "button.h" diff --git a/objects/client.c b/objects/client.c index f38e1626..40ba1525 100644 --- a/objects/client.c +++ b/objects/client.c @@ -84,7 +84,7 @@ * * @author Julien Danjou <julien@danjou.info> * @copyright 2008-2009 Julien Danjou - * @classmod client + * @coreclassmod client */ #include "objects/client.h" diff --git a/objects/drawable.c b/objects/drawable.c index f041ecc0..89e750d6 100644 --- a/objects/drawable.c +++ b/objects/drawable.c @@ -27,7 +27,7 @@ * * @author Uli Schlachter <psychon@znc.in> * @copyright 2012 Uli Schlachter - * @classmod drawable + * @coreclassmod drawable */ #include "drawable.h" diff --git a/objects/key.c b/objects/key.c index 932921ca..eca16c7f 100644 --- a/objects/key.c +++ b/objects/key.c @@ -31,7 +31,7 @@ * * @author Julien Danjou <julien@danjou.info> * @copyright 2008-2009 Julien Danjou - * @classmod key + * @coreclassmod key */ #include "objects/key.h" diff --git a/objects/screen.c b/objects/screen.c index 0800450f..cbc57c53 100644 --- a/objects/screen.c +++ b/objects/screen.c @@ -42,7 +42,7 @@ * * @author Julien Danjou <julien@danjou.info> * @copyright 2008-2009 Julien Danjou - * @classmod screen + * @coreclassmod screen */ #include "objects/screen.h" diff --git a/objects/tag.c b/objects/tag.c index 9b289dee..7c95aecc 100644 --- a/objects/tag.c +++ b/objects/tag.c @@ -180,7 +180,7 @@ * * @author Julien Danjou <julien@danjou.info> * @copyright 2008-2009 Julien Danjou - * @classmod tag + * @coreclassmod tag */ #include "tag.h" diff --git a/root.c b/root.c index bc649c40..9edef1d5 100644 --- a/root.c +++ b/root.c @@ -22,7 +22,7 @@ /** awesome root window API * @author Julien Danjou <julien@danjou.info> * @copyright 2008-2009 Julien Danjou - * @module root + * @coreclassmod root */ #include "globalconf.h"