Update lib/awful/wallpaper.lua

Co-authored-by: Aire-One <aireone@aireone.xyz>

lib/awful/wallpaper.lua

@@ -808,19 +808,24 @@ end
 
 --- Create a wallpaper.
 --
+-- Note that all parameters are not required. Please refer to the
+-- module description and examples to understand parameters usages.
+--
 -- @constructorfct awful.wallpaper
 -- @tparam table args
--- @tparam wibox.widget args.widget The wallpaper widget.
+-- @tparam[opt] wibox.widget args.widget The wallpaper widget.
--- @tparam number args.dpi The wallpaper DPI (dots per inch).
+-- @tparam[opt] number args.dpi The wallpaper DPI (dots per inch).
--- @tparam screen args.screen The wallpaper screen.
+-- @tparam[opt] screen args.screen The wallpaper screen.
--- @tparam table args.screens A list of screen for this wallpaper.
+-- @tparam[opt] table args.screens A list of screen for this wallpaper.
--- @tparam gears.color args.bg The background color.
+--  Use this parameter as a remplacement for `args.screen` to manage multiscreen wallpaper.
--- @tparam gears.color args.fg The foreground color.
+--  (Note: the expected table should be an array-like table `{screen1, screen2, ...}`)
--- @tparam gears.color args.uncovered_areas_color The color for the uncovered areas.
+-- @tparam[opt] gears.color args.bg The background color.
--- @tparam boolean args.honor_workarea Honor the workarea.
+-- @tparam[opt] gears.color args.fg The foreground color.
--- @tparam boolean args.honor_padding Honor the screen padding.
+-- @tparam[opt] gears.color args.uncovered_areas_color The color for the uncovered areas.
--- @tparam table args.uncovered_areas Returns the list of screen(s) area which won't be covered by the wallpaper.
+-- @tparam[opt] boolean args.honor_workarea Honor the workarea.
--- @tparam function|string args.panning_area Defines where the wallpaper is placed when there is multiple screens.
+-- @tparam[opt] boolean args.honor_padding Honor the screen padding.
+-- @tparam[opt] table args.uncovered_areas Returns the list of screen(s) area which won't be covered by the wallpaper.
+-- @tparam[opt] function|string args.panning_area Defines where the wallpaper is placed when there is multiple screens.
 
 local function new(_, args)
     args = args or {}