Changeset 2875 for code/branches/gui/src/orxonox/gamestates/GSGraphics.h

Timestamp:

Mar 31, 2009, 2:14:09 PM (15 years ago)

Author:

bknecht

Message:

(Doxygen) Documentation added for GUIManager and some GameState classes.

File:

• code/branches/gui/src/orxonox/gamestates/GSGraphics.h (modified) (3 diffs)

code/branches/gui/src/orxonox/gamestates/GSGraphics.h

@@ -23 +23 @@
  *      Reto Grieder
  *   Co-authors:
- *      ...
+ *      Benjamin Knecht (documentation)
  *
  */
+
+ /**
+    @file
+    @brief Declaration of the Graphics GameState class.
+  */
 
 #ifndef _GSGraphics_H__
@@ -36 +41 @@
 namespace orxonox
 {
+    /**
+    @class GSGraphics
+    @brief
+        Game state used when displaying graphics of any kind
+
+        This game state is only left out if we start a dedicated server where no graphics are present.
+    */
     class _OrxonoxExport GSGraphics : public GameState, public WindowEventListener
     {
@@ -55 +67 @@
 
         // managed singletons
-        InputManager*         inputManager_;
+        InputManager*         inputManager_;        //!< Reference to input management
         InGameConsole*        console_;
-        GUIManager*           guiManager_;
-        GraphicsManager*      graphicsManager_;       //!< Interface to Ogre
+        GUIManager*           guiManager_;          //!< Interface to GUI
+        GraphicsManager*      graphicsManager_;     //!< Interface to Ogre
 
-        KeyBinder*            masterKeyBinder_;
-        SimpleInputState*     masterInputState_;
+        KeyBinder*            masterKeyBinder_;     //!< Key binder for master key bindings
+        SimpleInputState*     masterInputState_;    //!< Special input state for master input
         XMLFile*              debugOverlay_;
-        ConsoleCommand*       ccToggleGUI_;
+        ConsoleCommand*       ccToggleGUI_;         //!< Console command to toggle GUI
     };
 }