From ded35502d5820af51891ae2151c0c65e866bf188 Mon Sep 17 00:00:00 2001 From: Emmanuel Lepage Vallee Date: Thu, 6 Jun 2019 03:40:17 -0400 Subject: [PATCH] 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. --- docs/config.ld | 1 + lib/gears/debug.lua | 2 +- lib/gears/filesystem.lua | 2 +- lib/gears/geometry.lua | 2 +- lib/gears/math.lua | 2 +- lib/gears/object.lua | 2 +- lib/gears/protected_call.lua | 2 +- lib/gears/sort/init.lua | 2 +- lib/gears/string.lua | 2 +- lib/gears/table.lua | 2 +- lib/gears/wallpaper.lua | 2 +- 11 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/config.ld b/docs/config.ld index 7b4eb69b..73a3370d 100644 --- a/docs/config.ld +++ b/docs/config.ld @@ -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 diff --git a/lib/gears/debug.lua b/lib/gears/debug.lua index fe5e934d..f8aeccff 100644 --- a/lib/gears/debug.lua +++ b/lib/gears/debug.lua @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- -- @author Uli Schlachter -- @copyright 2010 Uli Schlachter --- @module gears.debug +-- @utillib gears.debug --------------------------------------------------------------------------- local tostring = tostring diff --git a/lib/gears/filesystem.lua b/lib/gears/filesystem.lua index 5a12b1ad..3179292a 100644 --- a/lib/gears/filesystem.lua +++ b/lib/gears/filesystem.lua @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- --- Filesystem module for gears -- --- @module gears.filesystem +-- @utillib gears.filesystem --------------------------------------------------------------------------- -- Grab environment we need diff --git a/lib/gears/geometry.lua b/lib/gears/geometry.lua index 876fb1e6..98c5c2ab 100644 --- a/lib/gears/geometry.lua +++ b/lib/gears/geometry.lua @@ -7,7 +7,7 @@ -- -- @author Julien Danjou <julien@danjou.info> -- @copyright 2008 Julien Danjou --- @module gears.geometry +-- @utillib gears.geometry --------------------------------------------------------------------------- local math = math diff --git a/lib/gears/math.lua b/lib/gears/math.lua index accbe449..58c69ad8 100644 --- a/lib/gears/math.lua +++ b/lib/gears/math.lua @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- --- Math module for gears -- --- @module gears.math +-- @utillib gears.math --------------------------------------------------------------------------- local rtable = table diff --git a/lib/gears/object.lua b/lib/gears/object.lua index 4fe1d22b..d6f539fd 100644 --- a/lib/gears/object.lua +++ b/lib/gears/object.lua @@ -6,7 +6,7 @@ -- -- @author Uli Schlachter -- @copyright 2010 Uli Schlachter --- @classmod gears.object +-- @utillib gears.object --------------------------------------------------------------------------- local setmetatable = setmetatable diff --git a/lib/gears/protected_call.lua b/lib/gears/protected_call.lua index ef22f609..d8f62642 100644 --- a/lib/gears/protected_call.lua +++ b/lib/gears/protected_call.lua @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- -- @author Uli Schlachter -- @copyright 2016 Uli Schlachter --- @module gears.protected_call +-- @utillib gears.protected_call --------------------------------------------------------------------------- local gdebug = require("gears.debug") diff --git a/lib/gears/sort/init.lua b/lib/gears/sort/init.lua index 2f5e3b9a..02c2123f 100644 --- a/lib/gears/sort/init.lua +++ b/lib/gears/sort/init.lua @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- --- Extra sorting algorithms. -- --- @module gears.sort +-- @utillib gears.sort --------------------------------------------------------------------------- return { diff --git a/lib/gears/string.lua b/lib/gears/string.lua index 6b6eb6b0..84c57788 100644 --- a/lib/gears/string.lua +++ b/lib/gears/string.lua @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- --- String module for gears -- --- @module gears.string +-- @utillib gears.string --------------------------------------------------------------------------- local gstring = {} diff --git a/lib/gears/table.lua b/lib/gears/table.lua index d5f52574..70f99003 100644 --- a/lib/gears/table.lua +++ b/lib/gears/table.lua @@ -1,7 +1,7 @@ --------------------------------------------------------------------------- --- Table module for gears -- --- @module gears.table +-- @utillib gears.table --------------------------------------------------------------------------- diff --git a/lib/gears/wallpaper.lua b/lib/gears/wallpaper.lua index f238b475..13da9b7b 100644 --- a/lib/gears/wallpaper.lua +++ b/lib/gears/wallpaper.lua @@ -20,7 +20,7 @@ -- -- @author Uli Schlachter -- @copyright 2012 Uli Schlachter --- @module gears.wallpaper +-- @utillib gears.wallpaper --------------------------------------------------------------------------- local cairo = require("lgi").cairo