From 802f0add9270ce4cbd0070a8e019d22f9e5c1be2 Mon Sep 17 00:00:00 2001
From: Julien Danjou <julien@danjou.info>
Date: Tue, 29 Apr 2008 09:02:49 +0200
Subject: [PATCH] [uicb] Documentation enhancement

Signed-off-by: Julien Danjou <julien@danjou.info>
---
 uicb.c | 19 +++++++++----------
 1 file changed, 9 insertions(+), 10 deletions(-)

diff --git a/uicb.c b/uicb.c
index aa1cb45f7..827b0d49d 100644
--- a/uicb.c
+++ b/uicb.c
@@ -47,8 +47,8 @@ extern AwesomeConf globalconf;
 #include "uicbgen.h"
 
 /** Restart awesome with the current command line.
- * \param screen ID
- * \param arg arg (unused)
+ * \param screen The virtual screen number.
+ * \param arg An unused argument.
  * \ingroup ui_callback
  */
 void
@@ -58,8 +58,8 @@ uicb_restart(int screen, char *arg __attribute__ ((unused)))
 }
 
 /** Execute another process, replacing the current instance of awesome.
- * \param screen Screen ID
- * \param cmd Command
+ * \param screen The virtual screen number.
+ * \param cmd The command to start.
  * \ingroup ui_callback
  */
 void
@@ -93,8 +93,8 @@ uicb_exec(int screen __attribute__ ((unused)), char *cmd)
 }
 
 /** Spawn another process.
- * \param screen Screen ID
- * \param arg Command
+ * \param screen The virtual screen number.
+ * \param arg The command to run.
  * \ingroup ui_callback
  */
 void
@@ -119,7 +119,6 @@ uicb_spawn(int screen, char *arg)
         setenv("DISPLAY", newdisplay, 1);
     }
 
-
     /* The double-fork construct avoids zombie processes and keeps the code
      * clean from stupid signal handlers. */
     if(fork() == 0)
@@ -137,9 +136,9 @@ uicb_spawn(int screen, char *arg)
     wait(0);
 }
 
-/** Run the uicb
- * \param cmd the uicb command to parse
- * \return 0 on succes, -1 on failure
+/** Run the uicb.
+ * \param cmd The uicb command to parse.
+ * \return 0 on succes, -1 on failure.
  */
 static int
 __uicb_run(char *cmd)