doc: Add a section for the important classes.

The choice is very subjective, but at least they stand out.
This commit is contained in:
Emmanuel Lepage Vallee 2019-06-06 02:40:00 -04:00
parent 7b00d76673
commit 9d0c2200b2
14 changed files with 14 additions and 14 deletions

View File

@ -93,6 +93,7 @@ sort_modules=true
new_type("widgetmod" , "Widgets" , true) new_type("widgetmod" , "Widgets" , true)
new_type("containermod", "Widget containers", true) new_type("containermod", "Widget containers", true)
new_type("layoutmod" , "Widget layouts" , true) new_type("layoutmod" , "Widget layouts" , true)
new_type("coreclassmod", "Core components" , true)
file = { file = {
-- C parts of libraries -- C parts of libraries

View File

@ -60,7 +60,7 @@
-- @author Emmanuel Lepage Vallee <elv1313@gmail.com> -- @author Emmanuel Lepage Vallee <elv1313@gmail.com>
-- @copyright 2012 dodo -- @copyright 2012 dodo
-- @copyright 2017 Emmanuel Lepage Vallee -- @copyright 2017 Emmanuel Lepage Vallee
-- @classmod awful.keygrabber -- @coreclassmod awful.keygrabber
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local ipairs = ipairs local ipairs = ipairs
@ -731,7 +731,6 @@ end
-- @return the given callback `g`. -- @return the given callback `g`.
-- --
-- @deprecated awful.keygrabber.run -- @deprecated awful.keygrabber.run
-- @see keygrabber.run
--- A lower level API to interact with the keygrabber directly. --- A lower level API to interact with the keygrabber directly.
-- --

View File

@ -46,7 +46,7 @@
-- --
-- @author Uli Schlachter -- @author Uli Schlachter
-- @copyright 2014 Uli Schlachter -- @copyright 2014 Uli Schlachter
-- @classmod gears.timer -- @coreclassmod gears.timer
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local capi = { awesome = awesome } local capi = { awesome = awesome }

View File

@ -13,7 +13,7 @@
-- @author Emmanuel Lepage Vallee -- @author Emmanuel Lepage Vallee
-- @copyright 2008 koniu -- @copyright 2008 koniu
-- @copyright 2017 Emmanuel Lepage Vallee -- @copyright 2017 Emmanuel Lepage Vallee
-- @classmod naughty.notification -- @coreclassmod naughty.notification
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local gobject = require("gears.object") local gobject = require("gears.object")
local gtable = require("gears.table") local gtable = require("gears.table")

View File

@ -1,7 +1,7 @@
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
-- @author Uli Schlachter -- @author Uli Schlachter
-- @copyright 2010 Uli Schlachter -- @copyright 2010 Uli Schlachter
-- @classmod wibox -- @coreclassmod wibox
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
local capi = { local capi = {

View File

@ -57,7 +57,7 @@
* *
* @author Julien Danjou <julien@danjou.info> * @author Julien Danjou <julien@danjou.info>
* @copyright 2008-2009 Julien Danjou * @copyright 2008-2009 Julien Danjou
* @module mouse * @coreclassmod mouse
*/ */
#include "mouse.h" #include "mouse.h"

View File

@ -22,7 +22,7 @@
/** awesome mousegrabber API /** awesome mousegrabber API
* @author Julien Danjou <julien@danjou.info> * @author Julien Danjou <julien@danjou.info>
* @copyright 2008-2009 Julien Danjou * @copyright 2008-2009 Julien Danjou
* @module mousegrabber * @coreclassmod mousegrabber
*/ */
#include "mousegrabber.h" #include "mousegrabber.h"

View File

@ -30,7 +30,7 @@
* *
* @author Julien Danjou <julien@danjou.info> * @author Julien Danjou <julien@danjou.info>
* @copyright 2008-2009 Julien Danjou * @copyright 2008-2009 Julien Danjou
* @classmod button * @coreclassmod button
*/ */
#include "button.h" #include "button.h"

View File

@ -84,7 +84,7 @@
* *
* @author Julien Danjou <julien@danjou.info> * @author Julien Danjou <julien@danjou.info>
* @copyright 2008-2009 Julien Danjou * @copyright 2008-2009 Julien Danjou
* @classmod client * @coreclassmod client
*/ */
#include "objects/client.h" #include "objects/client.h"

View File

@ -27,7 +27,7 @@
* *
* @author Uli Schlachter <psychon@znc.in> * @author Uli Schlachter <psychon@znc.in>
* @copyright 2012 Uli Schlachter * @copyright 2012 Uli Schlachter
* @classmod drawable * @coreclassmod drawable
*/ */
#include "drawable.h" #include "drawable.h"

View File

@ -31,7 +31,7 @@
* *
* @author Julien Danjou <julien@danjou.info> * @author Julien Danjou <julien@danjou.info>
* @copyright 2008-2009 Julien Danjou * @copyright 2008-2009 Julien Danjou
* @classmod key * @coreclassmod key
*/ */
#include "objects/key.h" #include "objects/key.h"

View File

@ -42,7 +42,7 @@
* *
* @author Julien Danjou <julien@danjou.info> * @author Julien Danjou <julien@danjou.info>
* @copyright 2008-2009 Julien Danjou * @copyright 2008-2009 Julien Danjou
* @classmod screen * @coreclassmod screen
*/ */
#include "objects/screen.h" #include "objects/screen.h"

View File

@ -180,7 +180,7 @@
* *
* @author Julien Danjou <julien@danjou.info> * @author Julien Danjou <julien@danjou.info>
* @copyright 2008-2009 Julien Danjou * @copyright 2008-2009 Julien Danjou
* @classmod tag * @coreclassmod tag
*/ */
#include "tag.h" #include "tag.h"

2
root.c
View File

@ -22,7 +22,7 @@
/** awesome root window API /** awesome root window API
* @author Julien Danjou <julien@danjou.info> * @author Julien Danjou <julien@danjou.info>
* @copyright 2008-2009 Julien Danjou * @copyright 2008-2009 Julien Danjou
* @module root * @coreclassmod root
*/ */
#include "globalconf.h" #include "globalconf.h"