From c1f06b3d3feb9ba0ceae588e846e3254260bbee4 Mon Sep 17 00:00:00 2001 From: Julien Danjou Date: Wed, 27 Feb 2008 09:00:42 +0100 Subject: [PATCH] documentation update --- common/awclient.c | 10 +++++++++- common/awclient.h | 2 +- common/awesome-version.c | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/common/awclient.c b/common/awclient.c index af98bf7ba..230679a13 100644 --- a/common/awclient.c +++ b/common/awclient.c @@ -1,5 +1,5 @@ /* - * awesome-client-common.c - awesome client, communicate with socket, common functions + * awclient.c - awesome client, communicate with socket, common functions * * Copyright © 2007-2008 Julien Danjou * Copyright © 2007 daniel@brinkers.de @@ -29,6 +29,11 @@ #define CONTROL_UNIX_SOCKET_PATH ".awesome_ctl." +/** Get a sockaddr_un struct with information feeded for opening a + * communication to the awesome socket for given display + * \param display the display number + * \return sockaddr_un struct ready to be used or NULL if a problem occured + */ struct sockaddr_un * get_client_addr(const char *display) { @@ -72,6 +77,9 @@ get_client_addr(const char *display) return addr; } +/** Get a AF_UNIX socket for communicating with awesome + * \return the socket file descriptor + */ int get_client_socket(void) { diff --git a/common/awclient.h b/common/awclient.h index 23b1805f1..4bc8492d2 100644 --- a/common/awclient.h +++ b/common/awclient.h @@ -1,5 +1,5 @@ /* - * awesome-client.h - awesome client header + * awclient.h - awesome client header * * Copyright © 2007-2008 Julien Danjou * diff --git a/common/awesome-version.c b/common/awesome-version.c index 70023370d..b47775820 100644 --- a/common/awesome-version.c +++ b/common/awesome-version.c @@ -26,8 +26,8 @@ #include "awesome-version-internal.h" /** \brief Print version message and quit program. + * \param executable program name */ - void eprint_version(const char *const executable) {