diff --git a/luadoc/awesome.lua b/luadoc/awesome.lua index ea07ec804..11795eb8c 100644 --- a/luadoc/awesome.lua +++ b/luadoc/awesome.lua @@ -4,13 +4,10 @@ module("awesome") --- awesome global table. --- @field font The default font. --- @field font_height The default font height. --- @field fg The default foreground color. --- @field bg The default background color. -- @field version The version of awesome. -- @field release The release name of awesome. -- @field conffile The configuration file which has been loaded. +-- @field startup_errors Error message for errors that occured during startup. -- @field composite_manager_running True if a composite manager is running. -- @class table -- @name awesome diff --git a/luadoc/drawin.lua b/luadoc/drawin.lua index fd3994585..92fc18df9 100644 --- a/luadoc/drawin.lua +++ b/luadoc/drawin.lua @@ -4,18 +4,19 @@ module("drawin") --- Drawin object. --- @field screen Screen number. -- @field border_width Border width. -- @field border_color Border color. -- @field ontop On top of other windows. -- @field cursor The mouse cursor. -- @field visible Visibility. -- @field opacity The opacity of the drawin, between 0 and 1. +-- @field type The window type (desktop, normal, dock, …). -- @field x The x coordinates. -- @field y The y coordinates. -- @field width The width of the drawin. -- @field height The height of the drawin. -- @field drawable The drawin's drawable. +-- @field window The X window id. -- @field shape_bounding The drawin's bounding shape as a (native) cairo surface. -- @field shape_clip The drawin's clip shape as a (native) cairo surface. -- @class table diff --git a/luadoc/mouse.lua b/luadoc/mouse.lua index e150a4ac1..7c06b62b5 100644 --- a/luadoc/mouse.lua +++ b/luadoc/mouse.lua @@ -4,7 +4,6 @@ module("mouse") --- Mouse library. --- @field coords Mouse coordinates. -- @field screen Mouse screen number. -- @class table -- @name mouse diff --git a/luadoc/root.lua b/luadoc/root.lua index 1d30fb57e..dde12a4b5 100644 --- a/luadoc/root.lua +++ b/luadoc/root.lua @@ -33,9 +33,9 @@ module("root") -- @name fake_input -- @class function ---- Get the wiboxes attached to a screen. --- @return A table with all wiboxes. --- @name wiboxes +--- Get the drawins attached to a screen. +-- @return A table with all drawins. +-- @name drawins -- @class function --- Get the wallpaper as a cairo surface or set it as a cairo pattern. diff --git a/luadoc/timer.lua b/luadoc/timer.lua index 5e5d4b19a..51edcc299 100644 --- a/luadoc/timer.lua +++ b/luadoc/timer.lua @@ -19,6 +19,10 @@ module("timer") -- @name stop -- @class function +--- Restart the timer. +-- @name again +-- @class function + --- Add a signal. -- @param name A signal name. -- @param func A function to call when the signal is emitted.