# HG changeset patch
# User ib
# Date 1395238590 0
# Node ID 6738386f30dafb16d5a53d5bebd7af0f2fd90481
# Parent  b99b9968056b25b313c6121baa37ce042329dbf0
Add doxygen comment.

Additionally, rename a variable.

diff -r b99b9968056b -r 6738386f30da gui/wm/ws.c
--- a/gui/wm/ws.c	Wed Mar 19 14:07:47 2014 +0000
+++ b/gui/wm/ws.c	Wed Mar 19 14:16:30 2014 +0000
@@ -1424,12 +1424,16 @@
     wsImageCreate(win, w, h);
 }
 
-// ----------------------------------------------------------------------------------------------
-//    Show / hide mouse cursor.
-// ----------------------------------------------------------------------------------------------
-void wsMouseVisibility(wsWindow *win, int vis)
+/**
+ * @brief Hide or show the mouse pointer in a window.
+ *
+ * @param win pointer to a ws window structure
+ * @param visibility either #wsHideMouseCursor to hide or #wsShowMouseCursor
+ *                   to show the mouse pointer in the window
+ */
+void wsMouseVisibility(wsWindow *win, int visibility)
 {
-    switch (vis) {
+    switch (visibility) {
     case wsShowMouseCursor:
 
         if (win->wsCursor != None) {
diff -r b99b9968056b -r 6738386f30da gui/wm/ws.h
--- a/gui/wm/ws.h	Wed Mar 19 14:07:47 2014 +0000
+++ b/gui/wm/ws.h	Wed Mar 19 14:16:30 2014 +0000
@@ -178,10 +178,7 @@
 void wsWindowShape(wsWindow *win, char *data);
 void wsWindowIcon(Display *display, Window Win, guiIcon_t *icon);
 
-// ----------------------------------------------------------------------------------------------
-//    Show / hide mouse cursor.
-// ----------------------------------------------------------------------------------------------
-void wsMouseVisibility(wsWindow *win, int vis);
+void wsMouseVisibility(wsWindow *win, int visibility);
 
 // ----------------------------------------------------------------------------------------------
 // Image handling