From 80b79717baccc72f9c606c10919fd5b034e33acd Mon Sep 17 00:00:00 2001
From: Julien Danjou <julien@danjou.info>
Date: Mon, 28 Jul 2008 16:03:38 +0200
Subject: [PATCH] various documentation update for _index()

Signed-off-by: Julien Danjou <julien@danjou.info>
---
 client.c              | 2 +-
 mouse.c               | 2 +-
 statusbar.c           | 2 +-
 tag.c                 | 2 +-
 titlebar.c            | 2 +-
 widget.c              | 2 +-
 widgets/graph.c       | 2 +-
 widgets/progressbar.c | 2 +-
 widgets/taglist.c     | 5 ++++-
 widgets/tasklist.c    | 4 ++--
 widgets/textbox.c     | 2 +-
 11 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/client.c b/client.c
index d22803929..1f729d94e 100644
--- a/client.c
+++ b/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
diff --git a/mouse.c b/mouse.c
index 3e4a2d8e1..11cad9c8a 100644
--- a/mouse.c
+++ b/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
diff --git a/statusbar.c b/statusbar.c
index 13387379b..b486b416c 100644
--- a/statusbar.c
+++ b/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
diff --git a/tag.c b/tag.c
index feffddac8..60238d331 100644
--- a/tag.c
+++ b/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
diff --git a/titlebar.c b/titlebar.c
index f05631dec..7adfc7b86 100644
--- a/titlebar.c
+++ b/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
diff --git a/widget.c b/widget.c
index 543735cd8..5b5f0242f 100644
--- a/widget.c
+++ b/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
diff --git a/widgets/graph.c b/widgets/graph.c
index 64df3a120..0b927def9 100644
--- a/widgets/graph.c
+++ b/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.
diff --git a/widgets/progressbar.c b/widgets/progressbar.c
index 0fc4c4dcd..f3a23885d 100644
--- a/widgets/progressbar.c
+++ b/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.
diff --git a/widgets/taglist.c b/widgets/taglist.c
index 42823613b..5ba353d02 100644
--- a/widgets/taglist.c
+++ b/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)
diff --git a/widgets/tasklist.c b/widgets/tasklist.c
index 9a294c696..698095bb4 100644
--- a/widgets/tasklist.c
+++ b/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)
diff --git a/widgets/textbox.c b/widgets/textbox.c
index dcd574bd4..bc645e58a 100644
--- a/widgets/textbox.c
+++ b/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.