From 980afac1cf4bea0bc57c23ae747e1ee627943447 Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Wed, 19 Dec 2007 14:39:59 +1100
Subject: [PATCH] Make sure all uicb_ functions have doxygen annotations.

Also refactor some indentation while I'm there.
---
 client.c    |  4 ++++
 focus.c     |  5 +++++
 layout.c    | 35 +++++++++++++++++++++++++++++++++++
 mouse.c     | 22 +++++++++++++++++++---
 statusbar.c | 14 +++++++++++++-
 widget.c    |  5 +++++
 xutil.c     | 10 ++++++++++
 7 files changed, 91 insertions(+), 4 deletions(-)

diff --git a/client.c b/client.c
index 323af877..3b7ae149 100644
--- a/client.c
+++ b/client.c
@@ -660,6 +660,8 @@ uicb_setborder(int screen, char *arg)
 }
 
 /** Swap current with next client
+ * \param screen Screen ID
+ * \param arg nothing
  * \ingroup ui_callback
  */
 void
@@ -681,6 +683,8 @@ uicb_client_swapnext(int screen, char *arg __attribute__ ((unused)))
 }
 
 /** Swap current with previous client
+ * \param screen Screen ID
+ * \param arg nothing
  * \ingroup ui_callback
  */
 void
diff --git a/focus.c b/focus.c
index 143504cc..e5fd511d 100644
--- a/focus.c
+++ b/focus.c
@@ -106,6 +106,11 @@ focus_get_latest_client_for_tag(int screen, Tag *t)
     return NULL;
 }
 
+/** Jump in focus history stack
+ * \param screen Screen ID
+ * \param arg Integer argument
+ * \ingroup ui_callback
+ */
 void
 uicb_focus_history(int screen, char *arg)
 {
diff --git a/layout.c b/layout.c
index 0db7655c..bbb7d21d 100644
--- a/layout.c
+++ b/layout.c
@@ -99,6 +99,11 @@ get_current_layout(int screen)
     return NULL;
 }
 
+/** Send focus to next client in stack
+ * \param screen Screen ID
+ * \param arg Unused
+ * \ingroup ui_callback
+ */
 void
 uicb_client_focusnext(int screen, char *arg __attribute__ ((unused)))
 {
@@ -116,6 +121,11 @@ uicb_client_focusnext(int screen, char *arg __attribute__ ((unused)))
     }
 }
 
+/** Send focus to previous client in stack
+ * \param screen Screen ID
+ * \param arg Unused
+ * \ingroup ui_callback
+ */
 void
 uicb_client_focusprev(int screen, char *arg __attribute__ ((unused)))
 {
@@ -224,6 +234,11 @@ saveawesomeprops(int screen)
     p_delete(&prop);
 }
 
+/** Set layout for tag
+ * \param screen Screen ID
+ * \param arg Layout specifier
+ * \ingroup ui_callback
+ */
 void
 uicb_tag_setlayout(int screen, char *arg)
 {
@@ -277,6 +292,11 @@ maximize(int x, int y, int w, int h, int screen)
     arrange(screen);
 }
 
+/** Toggle maximize for client
+ * \param screen Screen ID
+ * \param arg Unused
+ * \ingroup ui_callback
+ */
 void
 uicb_client_togglemax(int screen, char *arg __attribute__ ((unused)))
 {
@@ -291,6 +311,11 @@ uicb_client_togglemax(int screen, char *arg __attribute__ ((unused)))
     p_delete(&si);
 }
 
+/** Toggle vertical maximize for client
+ * \param screen Screen ID
+ * \param arg Unused
+ * \ingroup ui_callback
+ */
 void
 uicb_client_toggleverticalmax(int screen, char *arg __attribute__ ((unused)))
 {
@@ -309,6 +334,11 @@ uicb_client_toggleverticalmax(int screen, char *arg __attribute__ ((unused)))
 }
 
 
+/** Toggle horizontal maximize for client
+ * \param screen Screen ID
+ * \param arg Unused
+ * \ingroup ui_callback
+ */
 void
 uicb_client_togglehorizontalmax(int screen, char *arg __attribute__ ((unused)))
 {
@@ -326,6 +356,11 @@ uicb_client_togglehorizontalmax(int screen, char *arg __attribute__ ((unused)))
     p_delete(&si);
 }
 
+/** Zoom client
+ * \param screen Screen ID
+ * \param arg Unused
+ * \ingroup ui_callback
+ */
 void
 uicb_client_zoom(int screen, char *arg __attribute__ ((unused)))
 {
diff --git a/mouse.c b/mouse.c
index 3baef6d1..6560b1d2 100644
--- a/mouse.c
+++ b/mouse.c
@@ -30,6 +30,11 @@
 
 extern awesome_config globalconf;
 
+/** Move client with mouse
+ * \param screen Screen ID
+ * \param arg Unused
+ * \ingroup ui_callback
+ */
 void
 uicb_client_movemouse(int screen, char *arg __attribute__ ((unused)))
 {
@@ -49,14 +54,20 @@ uicb_client_movemouse(int screen, char *arg __attribute__ ((unused)))
      else
          restack(screen);
 
-    si = get_screen_info(c->screen, globalconf.screens[screen].statusbar, &globalconf.screens[screen].padding);
+    si = get_screen_info(c->screen,
+                         globalconf.screens[screen].statusbar,
+                         &globalconf.screens[screen].padding);
 
     ocx = nx = c->x;
     ocy = ny = c->y;
-    if(XGrabPointer(c->display, RootWindow(c->display, c->phys_screen), False, MOUSEMASK, GrabModeAsync, GrabModeAsync,
+    if(XGrabPointer(c->display,
+                    RootWindow(c->display, c->phys_screen),
+                    False, MOUSEMASK, GrabModeAsync, GrabModeAsync,
                     None, globalconf.cursor[CurMove], CurrentTime) != GrabSuccess)
         return;
-    XQueryPointer(c->display, RootWindow(c->display, c->phys_screen), &dummy, &dummy, &x1, &y1, &di, &di, &dui);
+    XQueryPointer(c->display,
+                  RootWindow(c->display, c->phys_screen),
+                  &dummy, &dummy, &x1, &y1, &di, &di, &dui);
     for(;;)
     {
         XMaskEvent(c->display, MOUSEMASK | ExposureMask | SubstructureRedirectMask, &ev);
@@ -93,6 +104,11 @@ uicb_client_movemouse(int screen, char *arg __attribute__ ((unused)))
     }
 }
 
+/** Resize client with mouse
+ * \param screen Screen ID
+ * \param arg Unused
+ * \ingroup ui_callback
+ */
 void
 uicb_client_resizemouse(int screen, char *arg __attribute__ ((unused)))
 {
diff --git a/statusbar.c b/statusbar.c
index 0e3fc3de..4e22ff62 100644
--- a/statusbar.c
+++ b/statusbar.c
@@ -185,6 +185,11 @@ statusbar_get_position_from_str(const char * pos)
     return BarTop;
 }
 
+/** Toggle statusbar
+ * \param screen Screen ID
+ * \param arg Unused
+ * \ingroup ui_callback
+ */
 void
 uicb_statusbar_toggle(int screen, char *arg __attribute__ ((unused)))
 {
@@ -196,13 +201,20 @@ uicb_statusbar_toggle(int screen, char *arg __attribute__ ((unused)))
     arrange(screen);
 }
 
+/** Set statusbar position
+ * \param screen Screen ID
+ * \param arg off | bottom | right | left | top
+ * \ingroup ui_callback
+ */
 void
 uicb_statusbar_set_position(int screen, char *arg)
 {
     globalconf.screens[screen].statusbar->dposition = 
         globalconf.screens[screen].statusbar->position =
             statusbar_get_position_from_str(arg);
-    statusbar_update_position(globalconf.display, globalconf.screens[screen].statusbar, &globalconf.screens[screen].padding);
+    statusbar_update_position(globalconf.display,
+                              globalconf.screens[screen].statusbar,
+                              &globalconf.screens[screen].padding);
 }
 
 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80
diff --git a/widget.c b/widget.c
index b5efff83..aa685920 100644
--- a/widget.c
+++ b/widget.c
@@ -77,6 +77,11 @@ common_new(Widget *widget, Statusbar *statusbar, cfg_t* config)
 }
 
 
+/** Send command to widget
+ * \param screen Screen ID
+ * \param arg Widget command. Syntax depends on specific widget.
+ * \ingroup ui_callback
+ */
 void
 uicb_widget_tell(int screen, char *arg)
 {
diff --git a/xutil.c b/xutil.c
index 9253a9f9..9760e834 100644
--- a/xutil.c
+++ b/xutil.c
@@ -29,6 +29,11 @@
 
 extern awesome_config globalconf;
 
+/** Execute another process, replacing the current instance of Awesome
+ * \param screen Screen ID
+ * \param arg Command
+ * \ingroup ui_callback
+ */
 void
 uicb_exec(int screen __attribute__ ((unused)), char *arg)
 {
@@ -40,6 +45,11 @@ uicb_exec(int screen __attribute__ ((unused)), char *arg)
     execlp(path, arg, NULL);
 }
 
+/** Spawn another process
+ * \param screen Screen ID
+ * \param arg Command
+ * \ingroup ui_callback
+ */
 void
 uicb_spawn(int screen, char *arg)
 {