doc: Add a section for utility libraries

Dedicated for the modules extensions developers will need, but that the
general "I only edit rc.lua" user wont.
This commit is contained in:
Emmanuel Lepage Vallee 2019-06-06 03:40:17 -04:00
parent f1dceb02f6
commit ded35502d5
11 changed files with 11 additions and 10 deletions

View File

@ -95,6 +95,7 @@ new_type("containermod", "Widget containers", true)
new_type("layoutmod" , "Widget layouts" , true)
new_type("coreclassmod", "Core components" , true)
new_type("popupmod" , "Popups and bars" , true)
new_type("utillib" , "Utility libraries", true)
file = {
-- C parts of libraries

View File

@ -1,7 +1,7 @@
---------------------------------------------------------------------------
-- @author Uli Schlachter
-- @copyright 2010 Uli Schlachter
-- @module gears.debug
-- @utillib gears.debug
---------------------------------------------------------------------------
local tostring = tostring

View File

@ -1,7 +1,7 @@
---------------------------------------------------------------------------
--- Filesystem module for gears
--
-- @module gears.filesystem
-- @utillib gears.filesystem
---------------------------------------------------------------------------
-- Grab environment we need

View File

@ -7,7 +7,7 @@
--
-- @author Julien Danjou <julien@danjou.info>
-- @copyright 2008 Julien Danjou
-- @module gears.geometry
-- @utillib gears.geometry
---------------------------------------------------------------------------
local math = math

View File

@ -1,7 +1,7 @@
---------------------------------------------------------------------------
--- Math module for gears
--
-- @module gears.math
-- @utillib gears.math
---------------------------------------------------------------------------
local rtable = table

View File

@ -6,7 +6,7 @@
--
-- @author Uli Schlachter
-- @copyright 2010 Uli Schlachter
-- @classmod gears.object
-- @utillib gears.object
---------------------------------------------------------------------------
local setmetatable = setmetatable

View File

@ -1,7 +1,7 @@
---------------------------------------------------------------------------
-- @author Uli Schlachter
-- @copyright 2016 Uli Schlachter
-- @module gears.protected_call
-- @utillib gears.protected_call
---------------------------------------------------------------------------
local gdebug = require("gears.debug")

View File

@ -1,7 +1,7 @@
---------------------------------------------------------------------------
--- Extra sorting algorithms.
--
-- @module gears.sort
-- @utillib gears.sort
---------------------------------------------------------------------------
return {

View File

@ -1,7 +1,7 @@
---------------------------------------------------------------------------
--- String module for gears
--
-- @module gears.string
-- @utillib gears.string
---------------------------------------------------------------------------
local gstring = {}

View File

@ -1,7 +1,7 @@
---------------------------------------------------------------------------
--- Table module for gears
--
-- @module gears.table
-- @utillib gears.table
---------------------------------------------------------------------------

View File

@ -20,7 +20,7 @@
--
-- @author Uli Schlachter
-- @copyright 2012 Uli Schlachter
-- @module gears.wallpaper
-- @utillib gears.wallpaper
---------------------------------------------------------------------------
local cairo = require("lgi").cairo