Add references to gears.color in documentation.

This commit is contained in:
MoreThanOneAnimal 2016-11-20 01:01:39 -08:00
parent 333cd6491f
commit 51bbb53b30
5 changed files with 14 additions and 2 deletions

View file

@ -287,6 +287,7 @@ end
-- @param[opt] keypressed_callback The callback function to call
-- with mod table, key and command as arguments when a key was pressed.
-- [**DEPRECATED**]
-- @see gears.color
function prompt.run(args, textbox, exe_callback, completion_callback,
history_path, history_max, done_callback,
changed_callback, keypressed_callback)

View file

@ -88,6 +88,7 @@ end
--- Set the current wallpaper.
-- @param pattern The wallpaper that should be set. This can be a cairo surface,
-- a description for gears.color or a cairo pattern.
-- @see gears.color
function wallpaper.set(pattern)
if cairo.Surface:is_type_of(pattern) then
pattern = cairo.Pattern.create_for_surface(pattern)
@ -107,6 +108,7 @@ end
-- all screens are set.
-- @param background The background color that should be used. Gets handled via
-- gears.color. The default is black.
-- @see gears.color
function wallpaper.centered(surf, s, background)
local geom, cr = wallpaper.prepare_context(s)
surf = surface.load_uncached(surf)
@ -188,6 +190,7 @@ end
-- all screens are set.
-- @param background The background color that should be used. Gets handled via
-- gears.color. The default is black.
-- @see gears.color
function wallpaper.fit(surf, s, background)
local geom, cr = wallpaper.prepare_context(s)
surf = surface.load_uncached(surf)

View file

@ -216,6 +216,7 @@ end
--- Set the background of the drawable
-- @param c The background to use. This must either be a cairo pattern object,
-- nil or a string that gears.color() understands.
-- @see gears.color
function drawable:set_bg(c)
c = c or "#000000"
local t = type(c)
@ -263,6 +264,7 @@ end
--- Set the foreground of the drawable
-- @param c The foreground to use. This must either be a cairo pattern object,
-- nil or a string that gears.color() understands.
-- @see gears.color
function drawable:set_fg(c)
c = c or "#FFFFFF"
if type(c) == "string" or type(c) == "table" then

View file

@ -31,18 +31,20 @@ local graph = { mt = {} }
-- If the value is nil, no border will be drawn.
--
-- @property border_color
-- @tparam geats.color border_color The border color to set.
-- @tparam gears.color border_color The border color to set.
-- @see gears.color
--- Set the graph foreground color.
--
-- @property color
-- @tparam color color The graph color.
-- @see gears.color.create_pattern
-- @see gears.color
--- Set the graph background color.
--
-- @property background_color
-- @tparam gears.color background_color The graph background color.
-- @see gears.color
--- Set the maximum value the graph should handle.
-- If "scale" is also set, the graph never scales up below this value, but it

View file

@ -36,6 +36,7 @@ local progressbar = { mt = {} }
--
-- @property border_color
-- @tparam gears.color color The border color to set.
-- @see gears.color
--- The progressbar border width.
-- @property border_width
@ -45,6 +46,7 @@ local progressbar = { mt = {} }
--
-- @property bar_border_color
-- @tparam gears.color color The border color to set.
-- @see gears.color
--- The progressbar inner border width.
-- @property bar_border_width
@ -53,11 +55,13 @@ local progressbar = { mt = {} }
--
-- @property color
-- @tparam gears.color color The progressbar color.
-- @see gears.color
--- The progressbar background color.
--
-- @property background_color
-- @tparam gears.color color The progressbar background color.
-- @see gears.color
--- The progressbar inner shape.
--