various documentation update for _index()

Signed-off-by: Julien Danjou <julien@danjou.info>

client.c

@@ -1194,7 +1194,7 @@ luaA_client_newindex(lua_State *L)
     return 0;
 }
 
-/** Client index.
+/** Client object.
  * \param L The Lua VM state.
  * \return The number of elements pushed on stack.
  * \luastack

mouse.c

@@ -1065,7 +1065,7 @@ luaA_mouse_new(lua_State *L)
     return luaA_mouse_userdata_new(L, button);
 }
 
-/** Index for mouse.
+/** Mouse object.
  * \param L The Lua VM state.
  * \return The number of elements pushed on stack.
  * \luastack

statusbar.c

@@ -424,7 +424,7 @@ luaA_statusbar_widget_get(lua_State *L)
     return 1;
 }
 
-/** Statusbar index.
+/** Statusbar object.
  * \param L The Lua VM state.
  * \return The number of elements pushed on stack.
  * \luastack

tag.c

@@ -307,7 +307,7 @@ luaA_tag_new(lua_State *L)
     return luaA_tag_userdata_new(L, tag);
 }
 
-/** Tag index.
+/** Tag object.
  * \param L The Lua VM state.
  * \return The number of elements pushed on stack.
  * \luastack

titlebar.c

@@ -504,7 +504,7 @@ luaA_titlebar_newindex(lua_State *L)
     return 0;
 }
 
-/** Titlebar index.
+/** Titlebar object.
  * \param L The Lua VM state.
  * \return The number of elements pushed on stack.
  * \luastack

widget.c

@@ -341,7 +341,7 @@ luaA_widget_tostring(lua_State *L)
     return 1;
 }
 
-/** Generic widget index.
+/** Generic widget.
  * \param L The Lua VM state.
  * \return The number of elements pushed on stack.
  * \luastack

widgets/graph.c

@@ -412,7 +412,7 @@ luaA_graph_plot_data_add(lua_State *L)
     return 0;
 }
 
-/** Index function for graph widget.
+/** Graph widget.
  * \param L The Lua VM state.
  * \param token The key token.
  * \return The number of elements pushed on stack.

widgets/progressbar.c

@@ -505,7 +505,7 @@ luaA_progressbar_bar_data_add(lua_State *L)
     return 0;
 }
 
-/** Index function for progressbar.
+/** Progressbar widget.
  * \param L The Lua VM state.
  * \param token The key token.
  * \return The number of elements pushed on the stack.

widgets/taglist.c

@@ -181,10 +181,13 @@ taglist_button_press(widget_node_t *w,
             }
 }
 
-/** Index function for taglist.
+/** Taglist widget.
  * \param L The Lua VM state.
  * \param token The key token.
  * \return The number of elements pushed on stack.
+ * \luastack
+ * \lfield label Function used to get the string to display as the tag title.
+ * It gets the tag as argument, and must return a string.
  */
 static int
 luaA_taglist_index(lua_State *L, awesome_token_t token)

widgets/tasklist.c

@@ -283,14 +283,14 @@ tasklist_button_press(widget_node_t *w,
         }
 }
 
-/** Index function for tasklist widget.
+/** Tasklist widget.
  * \param L The Lua VM state.
  * \param token The key token.
  * \return The number of elements pushed on stack.
  * \luastack
  * \lfield show_icons Show icons near client title.
  * \lfield label Function used to get the string to display as the window title.
- * It gets the client as argument, and must return a string.
+ * It gets the client and a screen number as argument, and must return a string.
  */
 static int
 luaA_tasklist_index(lua_State *L, awesome_token_t token)

widgets/textbox.c

@@ -98,7 +98,7 @@ textbox_destructor(widget_t *w)
     p_delete(&d);
 }
 
-/** Textbox attributes.
+/** Textbox widget.
  * \param L The Lua VM state.
  * \param token The key token.
  * \return The number of elements pushed on stack.