mirror of
https://github.com/awesomeWM/awesome
synced 2024-11-17 07:47:41 +01:00
Update the luadoc for the C API
Thanks to blueyed for noticing that awesome.font doesn't exist any more! Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
parent
65a6febaf5
commit
2f3998639e
5 changed files with 10 additions and 9 deletions
|
@ -4,13 +4,10 @@
|
||||||
module("awesome")
|
module("awesome")
|
||||||
|
|
||||||
--- awesome global table.
|
--- 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 version The version of awesome.
|
||||||
-- @field release The release name of awesome.
|
-- @field release The release name of awesome.
|
||||||
-- @field conffile The configuration file which has been loaded.
|
-- @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.
|
-- @field composite_manager_running True if a composite manager is running.
|
||||||
-- @class table
|
-- @class table
|
||||||
-- @name awesome
|
-- @name awesome
|
||||||
|
|
|
@ -4,18 +4,19 @@
|
||||||
module("drawin")
|
module("drawin")
|
||||||
|
|
||||||
--- Drawin object.
|
--- Drawin object.
|
||||||
-- @field screen Screen number.
|
|
||||||
-- @field border_width Border width.
|
-- @field border_width Border width.
|
||||||
-- @field border_color Border color.
|
-- @field border_color Border color.
|
||||||
-- @field ontop On top of other windows.
|
-- @field ontop On top of other windows.
|
||||||
-- @field cursor The mouse cursor.
|
-- @field cursor The mouse cursor.
|
||||||
-- @field visible Visibility.
|
-- @field visible Visibility.
|
||||||
-- @field opacity The opacity of the drawin, between 0 and 1.
|
-- @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 x The x coordinates.
|
||||||
-- @field y The y coordinates.
|
-- @field y The y coordinates.
|
||||||
-- @field width The width of the drawin.
|
-- @field width The width of the drawin.
|
||||||
-- @field height The height of the drawin.
|
-- @field height The height of the drawin.
|
||||||
-- @field drawable The drawin's drawable.
|
-- @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_bounding The drawin's bounding shape as a (native) cairo surface.
|
||||||
-- @field shape_clip The drawin's clip shape as a (native) cairo surface.
|
-- @field shape_clip The drawin's clip shape as a (native) cairo surface.
|
||||||
-- @class table
|
-- @class table
|
||||||
|
|
|
@ -4,7 +4,6 @@
|
||||||
module("mouse")
|
module("mouse")
|
||||||
|
|
||||||
--- Mouse library.
|
--- Mouse library.
|
||||||
-- @field coords Mouse coordinates.
|
|
||||||
-- @field screen Mouse screen number.
|
-- @field screen Mouse screen number.
|
||||||
-- @class table
|
-- @class table
|
||||||
-- @name mouse
|
-- @name mouse
|
||||||
|
|
|
@ -33,9 +33,9 @@ module("root")
|
||||||
-- @name fake_input
|
-- @name fake_input
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
--- Get the wiboxes attached to a screen.
|
--- Get the drawins attached to a screen.
|
||||||
-- @return A table with all wiboxes.
|
-- @return A table with all drawins.
|
||||||
-- @name wiboxes
|
-- @name drawins
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
--- Get the wallpaper as a cairo surface or set it as a cairo pattern.
|
--- Get the wallpaper as a cairo surface or set it as a cairo pattern.
|
||||||
|
|
|
@ -19,6 +19,10 @@ module("timer")
|
||||||
-- @name stop
|
-- @name stop
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
--- Restart the timer.
|
||||||
|
-- @name again
|
||||||
|
-- @class function
|
||||||
|
|
||||||
--- Add a signal.
|
--- Add a signal.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emitted.
|
-- @param func A function to call when the signal is emitted.
|
||||||
|
|
Loading…
Reference in a new issue