Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[awesome-client] Add some more code documentation 

Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
Julien Danjou 2008-03-31 14:18:27 +02:00
parent 2779610ab5
commit e43ca13b6c
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
awesome-client.c
View File

@ -35,6 +35,11 @@
#define MSG_NOSIGNAL 0 #define MSG_NOSIGNAL 0
#endif #endif
/** Send a message to awesome.
* \param msg the message
* \param msg_len the message length
* \return errno of sendto()
*/
static int static int
send_msg(char *msg, ssize_t msg_len) send_msg(char *msg, ssize_t msg_len)
{ {
@ -68,6 +73,8 @@ send_msg(char *msg, ssize_t msg_len)
/** Print help and exit(2) with given exit_code. /** Print help and exit(2) with given exit_code.
* \param exit_code exit code
* \return never return
*/ */
static void __attribute__ ((noreturn)) static void __attribute__ ((noreturn))
exit_help(int exit_code) exit_help(int exit_code)
@ -79,9 +86,13 @@ exit_help(int exit_code)
exit(exit_code); exit(exit_code);
} }
/** Main function of awesome-client.
* \param argc number of args
* \param argv args array
* \return value returned by send_msg()
*/
int int
main(int argc, char *argv[]) main(int argc, char **argv)
{ {
char buf[1024], *msg; char buf[1024], *msg;
int ret_value = EXIT_SUCCESS; int ret_value = EXIT_SUCCESS;