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

[doxygen] Add \lvalue and convert existing doc. 

Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
Michael Gehring 2008-06-11 02:46:30 +02:00 committed by Julien Danjou
parent 6cd6e18e29
commit 276f5f8849
9 changed files with 87 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
awesome.doxygen.in
View File

@ -39,6 +39,7 @@ DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES SUBGROUPING = YES
ALIASES += luastack="\par Lua Stack:" ALIASES += luastack="\par Lua Stack:"
ALIASES += lvalue="- \em value "
ALIASES += lparam="- \em param " ALIASES += lparam="- \em param "
ALIASES += lreturn="- \em returns " ALIASES += lreturn="- \em returns "

2
build-utils/gendoc.lua
View File

@ -37,7 +37,7 @@ for i, line in ipairs(ilines) do
end end
comment = nil comment = nil
elseif comment_start then elseif comment_start then
if not line:find("\\param") and not line:find("\\return") then if not line:find("\\param") and not line:find("\\return") and not line:find("\\lvalue") then
comment = comment .. line comment = comment .. line
end end
end end

40
client.c
View File

@ -948,6 +948,7 @@ client_setborder(client_t *c, uint32_t width)
/** Set the client border width and color. /** Set the client border width and color.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A table with `width' key for the border width in pixel and `color' key * \lparam A table with `width' key for the border width in pixel and `color' key
* for the border color. * for the border color.
*/ */
@ -972,6 +973,7 @@ luaA_client_border_set(lua_State *L)
/** Move the client to another screen. /** Move the client to another screen.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A screen number. * \lparam A screen number.
*/ */
static int static int
@ -987,6 +989,7 @@ luaA_client_screen_set(lua_State *L)
/** Get the screen number the client is onto. /** Get the screen number the client is onto.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lreturn A screen number. * \lreturn A screen number.
*/ */
static int static int
@ -1000,6 +1003,7 @@ luaA_client_screen_get(lua_State *L)
/** Tag a client with a specified tag. /** Tag a client with a specified tag.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A tag object. * \lparam A tag object.
* \lparam A boolean value: true to add this tag to clients, false to remove. * \lparam A boolean value: true to add this tag to clients, false to remove.
*/ */
@ -1024,6 +1028,7 @@ luaA_client_tag(lua_State *L)
/** Check if a client is tagged with the specified tag. /** Check if a client is tagged with the specified tag.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A tag object. * \lparam A tag object.
* \lreturn A boolean value, true if the client is tagged with this tag, false * \lreturn A boolean value, true if the client is tagged with this tag, false
* otherwise. * otherwise.
@ -1040,6 +1045,7 @@ luaA_client_istagged(lua_State *L)
/** Get the client coordinates on the display. /** Get the client coordinates on the display.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lreturn A table with keys `width', `height', `x' and `y'. * \lreturn A table with keys `width', `height', `x' and `y'.
*/ */
static int static int
@ -1061,6 +1067,7 @@ luaA_client_coords_get(lua_State *L)
/** Set client coordinates. This only operates if the client is floating. /** Set client coordinates. This only operates if the client is floating.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A table with keys: x, y, width, height. * \lparam A table with keys: x, y, width, height.
*/ */
static int static int
@ -1086,6 +1093,7 @@ luaA_client_coords_set(lua_State *L)
* Note: this requires an external composite manager. * Note: this requires an external composite manager.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A floating value between 0 and 1. * \lparam A floating value between 0 and 1.
*/ */
static int static int
@ -1101,6 +1109,9 @@ luaA_client_opacity_set(lua_State *L)
/** Kill a client. /** Kill a client.
* \param L The Lua VM state. * \param L The Lua VM state.
*
* \luastack
* \lvalue A client.
*/ */
static int static int
luaA_client_kill(lua_State *L) luaA_client_kill(lua_State *L)
@ -1113,6 +1124,7 @@ luaA_client_kill(lua_State *L)
/** Swap a client with another one. /** Swap a client with another one.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A client to swap with. * \lparam A client to swap with.
*/ */
static int static int
@ -1130,6 +1142,9 @@ luaA_client_swap(lua_State *L)
/** Focus a client. /** Focus a client.
* \param L The Lua VM state. * \param L The Lua VM state.
*
* \luastack
* \lvalue A client.
*/ */
static int static int
luaA_client_focus_set(lua_State *L) luaA_client_focus_set(lua_State *L)
@ -1141,6 +1156,9 @@ luaA_client_focus_set(lua_State *L)
/** Raise a client on top of others which are on the same layer. /** Raise a client on top of others which are on the same layer.
* \param L The Lua VM state. * \param L The Lua VM state.
*
* \luastack
* \lvalue A client.
*/ */
static int static int
luaA_client_raise(lua_State *L) luaA_client_raise(lua_State *L)
@ -1153,6 +1171,7 @@ luaA_client_raise(lua_State *L)
/** Set the client floating attribute. /** Set the client floating attribute.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lparam A client.
* \lparam A boolean, true to set, false to unset. * \lparam A boolean, true to set, false to unset.
*/ */
static int static int
@ -1167,6 +1186,7 @@ luaA_client_floating_set(lua_State *L)
/** Check if a client has the floating attribute. /** Check if a client has the floating attribute.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lreturn A boolean, true if the client has the floating attribute set, false * \lreturn A boolean, true if the client has the floating attribute set, false
* otherwise. * otherwise.
*/ */
@ -1192,6 +1212,9 @@ luaA_client_eq(lua_State *L)
/** Redraw a client by unmapping and mapping it quickly. /** Redraw a client by unmapping and mapping it quickly.
* \param L The Lua VM state. * \param L The Lua VM state.
*
* \luastack
* \lvalue A client.
*/ */
static int static int
luaA_client_redraw(lua_State *L) luaA_client_redraw(lua_State *L)
@ -1205,6 +1228,7 @@ luaA_client_redraw(lua_State *L)
/** Return a formated string for a client. /** Return a formated string for a client.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lreturn A string. * \lreturn A string.
*/ */
static int static int
@ -1218,6 +1242,7 @@ luaA_client_tostring(lua_State *L)
/** Get the client name. /** Get the client name.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lreturn A string with the client class. * \lreturn A string with the client class.
*/ */
static int static int
@ -1235,6 +1260,7 @@ luaA_client_class_get(lua_State *L)
/** Set the default icon for this client. /** Set the default icon for this client.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A path to an icon image, or nil to remove. * \lparam A path to an icon image, or nil to remove.
*/ */
static int static int
@ -1252,6 +1278,7 @@ luaA_client_icon_set(lua_State *L)
/** Get the client name. /** Get the client name.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lreturn A string with the client name. * \lreturn A string with the client name.
*/ */
static int static int
@ -1265,6 +1292,7 @@ luaA_client_name_get(lua_State *L)
/** Change the client name. It'll change it only from awesome point of view. /** Change the client name. It'll change it only from awesome point of view.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A string with the new client name. * \lparam A string with the new client name.
*/ */
static int static int
@ -1280,6 +1308,7 @@ luaA_client_name_set(lua_State *L)
/** Set the client's titlebar. /** Set the client's titlebar.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lparam A titlebar. * \lparam A titlebar.
*/ */
static int static int
@ -1323,6 +1352,7 @@ luaA_client_titlebar_set(lua_State *L)
/** Get the titlebar of a client. /** Get the titlebar of a client.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack * \luastack
* \lvalue A client.
* \lreturn A titlebar or nil if the client has no titlebar. * \lreturn A titlebar or nil if the client has no titlebar.
*/ */
static int static int
@ -1338,6 +1368,8 @@ luaA_client_titlebar_get(lua_State *L)
/** Stop managing a client. /** Stop managing a client.
* \param L The Lua VM state. * \param L The Lua VM state.
* \luastack
* \lvalue A client.
*/ */
static int static int
luaA_client_unmanage(lua_State *L) luaA_client_unmanage(lua_State *L)
@ -1349,6 +1381,9 @@ luaA_client_unmanage(lua_State *L)
/** Hide a client. /** Hide a client.
* \param L The Lua VM state. * \param L The Lua VM state.
*
* \luastack
* \lvalue A client.
*/ */
static int static int
luaA_client_hide(lua_State *L) luaA_client_hide(lua_State *L)
@ -1361,6 +1396,9 @@ luaA_client_hide(lua_State *L)
/** Unhide a client. /** Unhide a client.
* \param L The Lua VM state. * \param L The Lua VM state.
*
* \luastack
* \lvalue A client.
*/ */
static int static int
luaA_client_unhide(lua_State *L) luaA_client_unhide(lua_State *L)
@ -1375,7 +1413,7 @@ luaA_client_unhide(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* * \lvalue A client.
* \lreturn A boolean, true if the client has been hidden with hide(), false * \lreturn A boolean, true if the client has been hidden with hide(), false
* otherwise. * otherwise.
*/ */

4
keybinding.c
View File

@ -91,7 +91,7 @@ luaA_keybinding_new(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A keybinding. * \lvalue A keybinding.
*/ */
static int static int
luaA_keybinding_add(lua_State *L) luaA_keybinding_add(lua_State *L)
@ -116,7 +116,7 @@ luaA_keybinding_add(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A keybinding. * \lvalue A keybinding.
*/ */
static int static int
luaA_keybinding_remove(lua_State *L) luaA_keybinding_remove(lua_State *L)

5
mouse.c
View File

@ -720,7 +720,6 @@ mouse_client_resize(client_t *c, corner_t corner)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A client.
* \lparam The x coordinate. * \lparam The x coordinate.
* \lparam The y coordinate. * \lparam The y coordinate.
*/ */
@ -740,7 +739,7 @@ luaA_mouse_coords_set(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A client. * \lvalue A client.
* \lparam An optionnal corner, such as bottomleft, topright, etc. * \lparam An optionnal corner, such as bottomleft, topright, etc.
*/ */
int int
@ -760,7 +759,7 @@ luaA_client_mouse_resize(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A client. * \lvalue A client.
* \lparam The pixel to snap. * \lparam The pixel to snap.
*/ */
int int

19
statusbar.c
View File

@ -277,7 +277,7 @@ statusbar_position_update(statusbar_t *statusbar, position_t position)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A statusbar. * \lvalue A statusbar.
* \lparam Another statusbar. * \lparam Another statusbar.
* \return True if statusbar are equals, false otherwise. * \return True if statusbar are equals, false otherwise.
*/ */
@ -294,7 +294,7 @@ luaA_statusbar_eq(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A statusbar. * \lvalue A statusbar.
* \lparam A position: left, right, top, bottom or off. * \lparam A position: left, right, top, bottom or off.
*/ */
static int static int
@ -318,7 +318,7 @@ luaA_statusbar_position_set(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A statusbar. * \lvalue A statusbar.
* \lreturn The statusbar position. * \lreturn The statusbar position.
*/ */
static int static int
@ -333,7 +333,7 @@ luaA_statusbar_position_get(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A statusbar, * \lvalue A statusbar,
* \lparam An alignment: right, left or center. * \lparam An alignment: right, left or center.
*/ */
static int static int
@ -353,7 +353,7 @@ luaA_statusbar_align_set(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A statusbar. * \lvalue A statusbar.
*/ */
static int static int
luaA_statusbar_tostring(lua_State *L) luaA_statusbar_tostring(lua_State *L)
@ -367,7 +367,7 @@ luaA_statusbar_tostring(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A statusbar. * \lvalue A statusbar.
* \lparam A widget. * \lparam A widget.
*/ */
static int static int
@ -389,7 +389,7 @@ luaA_statusbar_widget_add(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A stausbar * \lvalue A stausbar
* \lparam A screen number. * \lparam A screen number.
*/ */
static int static int
@ -426,6 +426,10 @@ luaA_statusbar_add(lua_State *L)
} }
/** Remove the statusbar its screen. /** Remove the statusbar its screen.
* \param L The Lua VM state.
*
* \luastack
* \lvalue A statusbar
*/ */
static int static int
luaA_statusbar_remove(lua_State *L) luaA_statusbar_remove(lua_State *L)
@ -514,6 +518,7 @@ luaA_statusbar_userdata_new(statusbar_t *t)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lvalue A statusbar.
* \lreturn A table with all widgets from the statusbar. * \lreturn A table with all widgets from the statusbar.
*/ */
static int static int

30
tag.c
View File

@ -239,7 +239,7 @@ tag_view_only_byindex(int screen, int dindex)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lparam Another tag. * \lparam Another tag.
* \lreturn True if tags are equals. * \lreturn True if tags are equals.
*/ */
@ -256,7 +256,7 @@ luaA_tag_eq(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lreturn A string. * \lreturn A string.
*/ */
static int static int
@ -271,7 +271,7 @@ luaA_tag_tostring(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lparam A screen number. * \lparam A screen number.
*/ */
static int static int
@ -356,7 +356,7 @@ luaA_tag_new(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lparam A boolean value, true to view tag, false otherwise. * \lparam A boolean value, true to view tag, false otherwise.
*/ */
static int static int
@ -372,7 +372,7 @@ luaA_tag_view(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lreturn True if the tag is viewed, false otherwise. * \lreturn True if the tag is viewed, false otherwise.
*/ */
static int static int
@ -388,7 +388,7 @@ luaA_tag_isselected(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lparam The master width ratio value, between 0 and 1. * \lparam The master width ratio value, between 0 and 1.
*/ */
static int static int
@ -412,7 +412,7 @@ luaA_tag_mwfact_set(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lreturn The master width ratio value. * \lreturn The master width ratio value.
*/ */
static int static int
@ -428,7 +428,7 @@ luaA_tag_mwfact_get(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lparam The number of columns, at least 1. * \lparam The number of columns, at least 1.
*/ */
static int static int
@ -452,7 +452,7 @@ luaA_tag_ncol_set(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lreturn The number of column. * \lreturn The number of column.
*/ */
static int static int
@ -468,7 +468,7 @@ luaA_tag_ncol_get(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lparam The number of master windows. * \lparam The number of master windows.
*/ */
static int static int
@ -492,7 +492,7 @@ luaA_tag_nmaster_set(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lreturn The number of master windows. * \lreturn The number of master windows.
*/ */
static int static int
@ -507,7 +507,7 @@ luaA_tag_nmaster_get(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lreturn The tag name. * \lreturn The tag name.
*/ */
static int static int
@ -522,7 +522,7 @@ luaA_tag_name_get(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lparam A string with the new tag name. * \lparam A string with the new tag name.
*/ */
static int static int
@ -550,7 +550,7 @@ luaA_tag_gc(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lreturn The layout name. * \lreturn The layout name.
*/ */
static int static int
@ -566,7 +566,7 @@ luaA_tag_layout_get(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A tag. * \lvalue A tag.
* \lparam A layout name. * \lparam A layout name.
*/ */
static int static int

6
titlebar.c
View File

@ -442,7 +442,7 @@ luaA_titlebar_new(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A titlebar. * \lvalue A titlebar.
* \lparam A widget. * \lparam A widget.
*/ */
static int static int
@ -471,7 +471,7 @@ luaA_titlebar_widget_add(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A titlebar * \lvalue A titlebar
* \lreturn A table with all widgets from the titlebar. * \lreturn A table with all widgets from the titlebar.
*/ */
static int static int
@ -499,7 +499,7 @@ luaA_titlebar_widget_get(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A titlebar. * \lvalue A titlebar.
* \lreturn A client if the titlebar is attached, nil otherwise. * \lreturn A client if the titlebar is attached, nil otherwise.
*/ */
static int static int

20
widget.c
View File

@ -349,7 +349,7 @@ luaA_widget_new(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A widget. * \lvalue A widget.
* \lparam A table containing modifiers keys. * \lparam A table containing modifiers keys.
* \lparam A button number. * \lparam A button number.
* \lparam A function to execute. Some widgets may pass arguments to this * \lparam A function to execute. Some widgets may pass arguments to this
@ -429,7 +429,7 @@ widget_tell_managestatus(widget_t *widget, widget_tell_status_t status, const ch
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A widget. * \lvalue A widget.
* \lparam The property name. * \lparam The property name.
* \lparam The property value. * \lparam The property value.
*/ */
@ -452,7 +452,7 @@ luaA_widget_set(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A widget. * \lvalue A widget.
*/ */
static int static int
luaA_widget_gc(lua_State *L) luaA_widget_gc(lua_State *L)
@ -467,7 +467,7 @@ luaA_widget_gc(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A widget. * \lvalue A widget.
*/ */
static int static int
luaA_widget_tostring(lua_State *L) luaA_widget_tostring(lua_State *L)
@ -481,7 +481,7 @@ luaA_widget_tostring(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A widget. * \lvalue A widget.
* \lparam Another widget. * \lparam Another widget.
* \lreturn True if widgets are equal. * \lreturn True if widgets are equal.
*/ */
@ -498,7 +498,7 @@ luaA_widget_eq(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A widget. * \lvalue A widget.
* \lparam A string with the new widget name. * \lparam A string with the new widget name.
*/ */
static int static int
@ -515,7 +515,7 @@ luaA_widget_name_set(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A widget. * \lvalue A widget.
* \lreturn A string with the name of the widget. * \lreturn A string with the name of the widget.
*/ */
static int static int
@ -531,7 +531,7 @@ luaA_widget_name_get(lua_State *L)
* \param L The Lua VM state. * \param L The Lua VM state.
* *
* \luastack * \luastack
* \lparam A widget. * \lvalue A widget.
* \lparam A boolean value. * \lparam A boolean value.
*/ */
static int static int
@ -544,6 +544,10 @@ luaA_widget_visible_set(lua_State *L)
} }
/** Get the visible attribute of a widget. /** Get the visible attribute of a widget.
* \param L The Lua VM state.
*
* \luastack
* \lvalue A widget.
* \return A boolean value, true if the widget is visible, false otherwise. * \return A boolean value, true if the widget is visible, false otherwise.
*/ */
static int static int