[uicb] Documentation enhancement

Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
Julien Danjou 2008-04-29 09:02:49 +02:00
parent fcb32dcf2e
commit 802f0add92
1 changed files with 9 additions and 10 deletions

19
uicb.c
View File

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