From 6e8b1383fe854324fa5aca1c721f978d4460b187 Mon Sep 17 00:00:00 2001
From: Aldo Cortesi <aldo@nullcube.com>
Date: Sun, 16 Dec 2007 13:14:47 +1100
Subject: [PATCH] Various doc comment fixes.

---
 awesome.c | 1 -
 client.c  | 5 +++--
 config.c  | 6 ++----
 layout.c  | 2 +-
 window.c  | 1 +
 5 files changed, 7 insertions(+), 8 deletions(-)

diff --git a/awesome.c b/awesome.c
index 05230de0..6503d80d 100644
--- a/awesome.c
+++ b/awesome.c
@@ -147,7 +147,6 @@ cleanup()
 }
 
 /** Scan X to find windows to manage
- * \param screen Screen number
  */
 static void
 scan()
diff --git a/client.c b/client.c
index f0cf0635..dabd0e62 100644
--- a/client.c
+++ b/client.c
@@ -78,7 +78,8 @@ client_loadprops(Client * c, int screen)
 }
 
 /** Check if client supports protocol WM_DELETE_WINDOW
- * \param c the client
+ * \param disp the display
+ * \win the Window
  * \return True if client has WM_DELETE_WINDOW
  */
 static Bool
@@ -99,6 +100,7 @@ isprotodel(Display *disp, Window win)
 }
 
 /** Swap two client in the linked list clients
+ * \param head pointer ito the client list head
  * \param c1 first client
  * \param c2 second client
  */
@@ -175,7 +177,6 @@ client_attach(Client *c)
 }
 
 /** Detach client from clients list
- * \param head client list
  * \param c client to detach
  */
 void
diff --git a/config.c b/config.c
index 7c853ec7..64edc665 100644
--- a/config.c
+++ b/config.c
@@ -245,8 +245,7 @@ static Key *section_keys(cfg_t *cfg_keys)
 
 
 /** Parse configuration file and initialize some stuff
- * \param disp Display ref
- * \param scr Screen number
+ * \param configpatharg Path to configuration file
  */
 void
 parse_config(const char *confpatharg)
@@ -662,10 +661,9 @@ get_numlockmask(Display *disp)
 }
 
 /** Initialize color from X side
- * \param colorstr Color code
  * \param disp Display ref
  * \param scr Screen number
- * \return XColor pixel
+ * \param colorstr Color code
  */
 static XColor
 initxcolor(Display *disp, int scr, const char *colstr)
diff --git a/layout.c b/layout.c
index c4923a8c..6fcf105d 100644
--- a/layout.c
+++ b/layout.c
@@ -50,7 +50,7 @@ get_current_tag(int screen)
 }
 
 /** Arrange windows following current selected layout
- * \param disp display ref
+ * \param screen the screen to arrange
  */
 void
 arrange(int screen)
diff --git a/window.c b/window.c
index 6c62dca3..2588b060 100644
--- a/window.c
+++ b/window.c
@@ -88,6 +88,7 @@ window_configure(Display *disp, Window win, int x, int y, int w, int h, int bord
 
 /** Grab or ungrab buttons on a window
  * \param disp Display ref
+ * \param screen The screen
  * \param focused True if client is focused
  * \param raised True if the client is above other clients
  * \param modkey Mod key mask