From 46ead6ea3fb20864ce2082fa97d16341d860fec5 Mon Sep 17 00:00:00 2001 From: Julien Danjou Date: Fri, 20 Jun 2008 08:32:46 +0200 Subject: [PATCH] comments fixing Signed-off-by: Julien Danjou --- awesome-client.c | 17 +++++++++-------- awesome.c | 24 ++++++++++++------------ client.c | 11 ++++++++--- cnode.c | 2 +- keygrabber.c | 1 + 5 files changed, 31 insertions(+), 24 deletions(-) diff --git a/awesome-client.c b/awesome-client.c index d8ff0c108..ee6e163bc 100644 --- a/awesome-client.c +++ b/awesome-client.c @@ -42,9 +42,9 @@ #endif /** Send a message to awesome. - * \param msg the message - * \param msg_len the message length - * \return errno of sendto() + * \param msg The message. + * \param msg_len The message length. + * \return The errno of sendto(). */ static int send_msg(const char *msg, ssize_t msg_len) @@ -79,8 +79,8 @@ send_msg(const char *msg, ssize_t msg_len) /** Print help and exit(2) with given exit_code. - * \param exit_code exit code - * \return never return + * \param exit_code The exit code. + * \return Never return. */ static void __attribute__ ((noreturn)) exit_help(int exit_code) @@ -93,9 +93,9 @@ exit_help(int exit_code) } /** Main function of awesome-client. - * \param argc number of args - * \param argv args array - * \return value returned by send_msg() + * \param argc Number of args. + * \param argv Args array. + * \return Value returned by send_msg(). */ int main(int argc, char **argv) @@ -156,4 +156,5 @@ main(int argc, char **argv) return ret_value; } + // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80 diff --git a/awesome.c b/awesome.c index 719d2fc2e..d6d08c9ef 100644 --- a/awesome.c +++ b/awesome.c @@ -60,7 +60,7 @@ typedef struct xcb_query_tree_cookie_t tree_cookie; } root_win_t; -/** Scan X to find windows to manage +/** Scan X to find windows to manage. */ static void scan(void) @@ -202,9 +202,9 @@ a_xcb_io_cb(EV_P_ ev_io *w, int revents) /** Startup Error handler to check if another window manager * is already running. - * \param data Additional optional parameters data - * \param c X connection - * \param error Error event + * \param data Additional optional parameters data. + * \param c X connection. + * \param error Error event. */ static int __attribute__ ((noreturn)) xerrorstart(void * data __attribute__ ((unused)), @@ -223,14 +223,14 @@ exit_on_signal(EV_P_ ev_signal *w, int revents) ev_unloop(EV_A_ 1); } -/** \brief awesome xerror function +/** \brief awesome xerror function. * There's no way to check accesses to destroyed windows, thus those cases are * ignored (especially on UnmapNotify's). Other types of errors call Xlibs * default error handler, which may call exit. - * \param data currently unused + * \param data Currently unused. * \param c The connectiont to the X server. - * \param e The error event - * \return 0 if no error, or xerror's xlib return status + * \param e The error event. + * \return 0 if no error, or xerror's xlib return status. */ static int xerror(void *data __attribute__ ((unused)), @@ -268,7 +268,7 @@ xerror(void *data __attribute__ ((unused)), } /** Print help and exit(2) with given exit_code. - * \param exit_code the exit code + * \param exit_code The exit code. */ static void __attribute__ ((noreturn)) exit_help(int exit_code) @@ -283,9 +283,9 @@ exit_help(int exit_code) } /** Hello, this is main. - * \param argc who knows - * \param argv who knows - * \return EXIT_SUCCESS I hope + * \param argc Who knows. + * \param argv Who knows. + * \return EXIT_SUCCESS I hope. */ int main(int argc, char **argv) diff --git a/client.c b/client.c index 91f4ed8e7..97ca6bdba 100644 --- a/client.c +++ b/client.c @@ -43,6 +43,11 @@ extern awesome_t globalconf; +/** Create a new client userdata. + * \param L The Lua VM state. + * \param p A client pointer. + * \param The number of elements pushed on the stack. + */ int luaA_client_userdata_new(lua_State *L, client_t *p) { @@ -97,7 +102,7 @@ client_loadprops(client_t * c, screen_t *screen) return result; } -/** Check if client supports protocol WM_DELETE_WINDOW, +/** Check if client supports protocol WM_DELETE_WINDOW. * \param win The window. * \return True if client has WM_DELETE_WINDOW, false otherwise. */ @@ -215,7 +220,7 @@ client_ban(client_t *c) xcb_unmap_window(globalconf.connection, c->titlebar->sw->window); } -/** Give focus to client, or to first client if client is NULL, +/** Give focus to client, or to first client if client is NULL. * \param c The client or NULL. * \param screen Virtual screen number. * \return True if a window (even root) has received focus, false otherwise. @@ -700,7 +705,7 @@ client_updatewmhints(client_t *c) } /** Update the size hintz of a client. - * \param c The client + * \param c The client. * \return A pointer to a xcb_size_hints_t. */ xcb_size_hints_t * diff --git a/cnode.c b/cnode.c index bc0d58dad..9df80c1f1 100644 --- a/cnode.c +++ b/cnode.c @@ -40,7 +40,7 @@ client_node_client_getby(client_node_t *list, client_t *c) /** Create a client node for focus. * \param list The client list. - * \param c The client + * \param c The client. * \return The client focus node. */ client_node_t * diff --git a/keygrabber.c b/keygrabber.c index 4204dee0b..3dccdcbc5 100644 --- a/keygrabber.c +++ b/keygrabber.c @@ -656,6 +656,7 @@ key_press_lookup_string(xcb_key_press_event_t *e, } /** Grab the keyboard. + * \return True if keyboard was grabbed. */ static bool keygrabber_grab(void)