doc: Use @property for the progressbar doc.

This commit is contained in:
Emmanuel Lepage Vallee 2016-07-23 19:02:00 -04:00
parent 8d7f228301
commit e28b79944f
1 changed files with 22 additions and 30 deletions

View File

@ -18,54 +18,46 @@ local beautiful = require("beautiful")
local progressbar = { mt = {} } local progressbar = { mt = {} }
--- Set the progressbar border color. --- The progressbar border color.
-- If the value is nil, no border will be drawn. -- If the value is nil, no border will be drawn.
-- --
-- @function set_border_color -- @property border_color
-- @param progressbar The progressbar. -- @tparam gears.color color The border color to set.
-- @param color The border color to set.
--- Set the progressbar foreground color. --- The progressbar foreground color.
-- --
-- @function set_color -- @property color
-- @param progressbar The progressbar. -- @tparam gears.color color The progressbar color.
-- @param color The progressbar color.
--- Set the progressbar background color. --- The progressbar background color.
-- --
-- @function set_background_color -- @property background_color
-- @param progressbar The progressbar. -- @tparam gears.color color The progressbar background color.
-- @param color The progressbar background color.
--- Set the progressbar to draw vertically. Default is false. --- Set the progressbar to draw vertically. Default is false.
-- --
-- @deprecated set_vertical -- @deprecated set_vertical
-- @param progressbar The progressbar. -- @tparam boolean vertical
-- @param vertical A boolean value.
--- Set the progressbar to draw ticks. Default is false. --- The progressbar to draw ticks. Default is false.
-- --
-- @function set_ticks -- @property ticks
-- @param progressbar The progressbar. -- @param boolean
-- @param ticks A boolean value.
--- Set the progressbar ticks gap. --- The progressbar ticks gap.
-- --
-- @function set_ticks_gap -- @property ticks_gap
-- @param progressbar The progressbar. -- @param number
-- @param value The value.
--- Set the progressbar ticks size. --- The progressbar ticks size.
-- --
-- @function set_ticks_size -- @property ticks_size
-- @param progressbar The progressbar. -- @param number
-- @param value The value.
--- Set the maximum value the progressbar should handle. --- The maximum value the progressbar should handle.
-- --
-- @function set_max_value -- @property max_value
-- @param progressbar The progressbar. -- @param number
-- @param value The value.
--- The progressbar background color. --- The progressbar background color.
-- @beautiful beautiful.progressbar_bg -- @beautiful beautiful.progressbar_bg