Changeset 3454 in orxonox.OLD for orxonox/trunk/src/importer/windowHandler.h

Timestamp:

Mar 3, 2005, 6:35:04 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk/importer: doxygen-tags

File:

• orxonox/trunk/src/importer/windowHandler.h (modified) (3 diffs)

orxonox/trunk/src/importer/windowHandler.h

@@ +1 @@
+/*!
+  \file windowHandler.h
+  \brief contains the WindowHandler class for the minimal display system
+*/
+
+
 #ifndef _WINDOWHANDLER_H
 #define _WINDOWHANDLER_H
@@ -16 +22 @@
 #endif /* __WIN32__ */
 
-#define TRUE 1
-#define FALSE 0
-#define BOOL int
+#define TRUE 1     //!< define true
+#define FALSE 0    //!< define false
+#define BOOL int   //!< define BOOL
 
+//! A simple class to handle a minimal display system
 class WindowHandler
 {
@@ -27 +34 @@
     GLvoid KillGLWindow(GLvoid);
     BOOL CreateGLWindow(char* title, int width, int height, int bits, BOOL fullscreenflag);
-    SDL_Surface* screen;
+    SDL_Surface* screen;   //!< The screen to which to display the rendered stuff
   private:
     int InitGL(GLvoid);