Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #1932 from mqus/patch-1 

Fix awful.widget.calendar_popup documentation
This commit is contained in:
Emmanuel Lepage Vallée 2017-07-19 11:43:22 -04:00 committed by GitHub
parent cb10a3fe45 bd5f0dd3fc
commit 81398f3d0a
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lib/awful/widget/calendar_popup.lua
View File

@ -241,7 +241,7 @@ end
--- Attach the calendar to a widget to display at a specific position. --- Attach the calendar to a widget to display at a specific position.
-- --
-- local mytextclock = wibox.widget.textclock() -- local mytextclock = wibox.widget.textclock()
-- local month_calendar = calendar.month() -- local month_calendar = awful.widget.calendar_popup.month()
-- month_calendar:attach(mytextclock, 'tr') -- month_calendar:attach(mytextclock, 'tr')
-- --
-- @param widget Widget to attach the calendar -- @param widget Widget to attach the calendar
@ -325,6 +325,7 @@ end
--@DOC_wibox_awidget_calendar_month_wibox_EXAMPLE@ --@DOC_wibox_awidget_calendar_month_wibox_EXAMPLE@
-- --
-- local mytextclock = wibox.widget.textclock() -- local mytextclock = wibox.widget.textclock()
-- local month_calendar = awful.widget.calendar_popup.month()
-- month_calendar:attach( mytextclock, "tr" ) -- month_calendar:attach( mytextclock, "tr" )
-- --
-- @tparam table args Properties of the widget -- @tparam table args Properties of the widget
@ -344,7 +345,7 @@ end
-- @tparam table args.style_normal Cell style for the normal day cells (see `cell_properties`) -- @tparam table args.style_normal Cell style for the normal day cells (see `cell_properties`)
-- @tparam table args.style_focus Cell style for the current day cell (see `cell_properties`) -- @tparam table args.style_focus Cell style for the current day cell (see `cell_properties`)
-- @treturn wibox A wibox containing the calendar -- @treturn wibox A wibox containing the calendar
-- @function awful.widget.calendar.month -- @function awful.widget.calendar_popup.month
function calendar_popup.month(args) function calendar_popup.month(args)
return get_cal_wibox("month", args) return get_cal_wibox("month", args)
end end
@ -380,7 +381,7 @@ end
-- @tparam table args.style_normal Cell style for the normal day cells (see `cell_properties`) -- @tparam table args.style_normal Cell style for the normal day cells (see `cell_properties`)
-- @tparam table args.style_focus Cell style for the current day cell (see `cell_properties`) -- @tparam table args.style_focus Cell style for the current day cell (see `cell_properties`)
-- @treturn wibox A wibox containing the calendar -- @treturn wibox A wibox containing the calendar
-- @function awful.widget.calendar.year -- @function awful.widget.calendar_popup.year
function calendar_popup.year(args) function calendar_popup.year(args)
return get_cal_wibox("year", args) return get_cal_wibox("year", args)
end end