Changeset 56927 in vbox

Timestamp:

Jul 14, 2015 1:48:35 PM (9 years ago)

Author:

vboxsync

Message:

FE/Qt: X11: Helpers cleanup/rework (step 1): Doxy.

Location:

trunk/src/VBox/Frontends/VirtualBox/src/platform/x11

Files:

• VBoxX11Helper.cpp (modified) (5 diffs)
• VBoxX11Helper.h (modified) (2 diffs)

trunk/src/VBox/Frontends/VirtualBox/src/platform/x11/VBoxX11Helper.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2008-2010 Oracle Corporation
+ * Copyright (C) 2008-2015 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -33 +33 @@
 static BOOL gX11DpmsState;
 
-/**
- * Init the screen saver save/restore mechanism.
- */
 void X11ScreenSaverSettingsInit()
 {
@@ -44 +41 @@
 }
 
-/**
- * Actually this is a big mess. By default the libSDL disables the screen
- * saver during the SDL_InitSubSystem() call and restores the saved settings
- * during the SDL_QuitSubSystem() call. This mechanism can be disabled by
- * setting the environment variable SDL_VIDEO_ALLOW_SCREENSAVER to 1. However,
- * there is a known bug in the Debian libSDL: If this environment variable is
- * set, the screen saver is still disabled but the old state is not restored
- * during SDL_QuitSubSystem()! So the only solution to overcome this problem
- * is to save and restore the state prior and after each of these function
- * calls.
- */
 void X11ScreenSaverSettingsSave()
 {
+    /* Actually this is a big mess. By default the libSDL disables the screen saver
+     * during the SDL_InitSubSystem() call and restores the saved settings during
+     * the SDL_QuitSubSystem() call. This mechanism can be disabled by setting the
+     * environment variable SDL_VIDEO_ALLOW_SCREENSAVER to 1. However, there is a
+     * known bug in the Debian libSDL: If this environment variable is set, the
+     * screen saver is still disabled but the old state is not restored during
+     * SDL_QuitSubSystem()! So the only solution to overcome this problem is to
+     * save and restore the state prior and after each of these function calls. */
+
     int     dummy;
     CARD16  dummy2;
@@ -66 +61 @@
 }
 
-/**
- * Restore previously saved screen saver settings.
- */
 void X11ScreenSaverSettingsRestore()
 {
@@ -82 +74 @@
 }
 
-/**
- * Determine if the current Window manager is KWin (KDE)
- */
 bool X11IsWindowManagerKWin()
 {

trunk/src/VBox/Frontends/VirtualBox/src/platform/x11/VBoxX11Helper.h

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2015 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -16 +16 @@
  */
 
-#ifndef __VBoxX11Helpers_h__
-#define __VBoxX11Helpers_h__
+#ifndef ___VBoxX11Helpers_h___
+#define ___VBoxX11Helpers_h___
 
+/** X11: Inits the screen saver save/restore mechanism. */
 void X11ScreenSaverSettingsInit();
+/** X11: Saves screen saver settings. */
 void X11ScreenSaverSettingsSave();
+/** X11: Restores previously saved screen saver settings. */
 void X11ScreenSaverSettingsRestore();
+
+/** X11: Determines whether current Window Manager is KWin. */
 bool X11IsWindowManagerKWin();
 
-#endif
+#endif /* !___VBoxX11Helpers_h___ */