[MPlayer-cvslog] r37024 - in trunk/gui/wm: ws.c ws.h

[ib]

Author: ib
Date: Wed Mar 19 15:16:30 2014
New Revision: 37024

Log:
Add doxygen comment.

Additionally, rename a variabble.

Modified:
   trunk/gui/wm/ws.c
   trunk/gui/wm/ws.h

Modified: trunk/gui/wm/ws.c
==============================================================================
--- trunk/gui/wm/ws.c	Wed Mar 19 15:07:47 2014	(r37023)
+++ trunk/gui/wm/ws.c	Wed Mar 19 15:16:30 2014	(r37024)
@@ -1424,12 +1424,16 @@ void wsImageResize(wsWindow *win, int w,
     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) {

Modified: trunk/gui/wm/ws.h
==============================================================================
--- trunk/gui/wm/ws.h	Wed Mar 19 15:07:47 2014	(r37023)
+++ trunk/gui/wm/ws.h	Wed Mar 19 15:16:30 2014	(r37024)
@@ -178,10 +178,7 @@ void wsWindowRedraw(wsWindow *win);
 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