awesomewm-mirrors
/
awesome
mirror of https://github.com/awesomeWM/awesome.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

root: Update the property documentation.

This commit is contained in:
Emmanuel Lepage Vallee 2022-08-21 23:02:27 -07:00
parent 1998fe8609
commit 4ff17396b6
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
root.c
View File

@ -349,7 +349,8 @@ luaA_root_fake_input(lua_State *L)
* (the wallpaper). * (the wallpaper).
* *
* @property keys * @property keys
* @tparam table keys * @tparam[opt={}] table keys
* @tablerowtype A list of `awful.key` objects.
* @see awful.key * @see awful.key
*/ */
static int static int
@ -390,7 +391,8 @@ luaA_root_keys(lua_State *L)
* known as root window). * known as root window).
* *
* @property buttons * @property buttons
* @tparam[opt={}] table buttons The list of buttons. * @tparam[opt={}] table buttons
* @tablerowtype A list of `awful.button` objects.
* @see awful.button * @see awful.button
* *
* @usage * @usage
@ -516,7 +518,9 @@ luaA_root_wallpaper(lua_State *L)
/** Get the content of the root window as a cairo surface. /** Get the content of the root window as a cairo surface.
* *
* @property content * @property content
* @tparam surface content A cairo surface with the root window content (aka the whole surface from every screens). * @tparam raw_surface content A cairo surface with the root window content (aka the whole surface from every screens).
* @propertydefault This is the live content. Use `gears.surface(root.content)` to
* take a screenshot.
* @see gears.surface * @see gears.surface
*/ */
static int static int