opengate-svn Mailing List for Open Jumpgate (Page 31)

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 476
          http://svn.sourceforge.net/opengate/?rev=476&view=rev
Author:   egore
Date:     2007-05-17 12:01:55 -0700 (Thu, 17 May 2007)

Log Message:
-----------
[QA] few more doxygen comments

Modified Paths:
--------------
    branches/ogsector/src/GameState.h
    branches/ogsector/src/GameStateManager.h
    branches/ogsector/src/InputManager.cpp
    branches/ogsector/src/InputManager.h
    branches/ogsector/src/networkServer.h

Modified: branches/ogsector/src/GameState.h
===================================================================

--- branches/ogsector/src/GameState.h	2007-05-17 18:41:36 UTC (rev 475)
+++ branches/ogsector/src/GameState.h	2007-05-17 19:01:55 UTC (rev 476)
@@ -18,9 +18,10 @@
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef GAMESTATELISTENER__H
-#define GAMESTATELISTENER__H
+#ifndef _OPENGATE_GAMESTATELISTENER__H
+#define _OPENGATE_GAMESTATELISTENER__H
 
+// Necessary hack for CEGUI
 #include <OgreNoMemoryMacros.h>
 #include <CEGUI/CEGUIImageset.h>
 #include <CEGUI/CEGUISystem.h>
@@ -44,6 +45,12 @@
 class NetworkClient;
 class GameState;
 
+/*!
+ * \brief This is a storage to handle current status of several things
+ *
+ * \todo Describe what it is used for, I don't really get it.
+ * \author Carsten <spo...@us...>
+ */
 typedef struct {
   Ogre::Root               * ogreRoot;
   Ogre::RenderWindow       * renderWindow;
@@ -53,8 +60,14 @@
   NetworkClient            * network;
 } DeviceInfo;
 
+/*!
+ * \brief This abstract class defines the listener attached to a gamestate
+ *
+ * \author Carsten <spo...@us...>
+ */
 class GameStateListener {
 public:
+
   /*! Constructor */
   GameStateListener( ){ };
 
@@ -64,7 +77,7 @@
   /*! Store a game state to manage. */
   virtual void manageGameState( const std::string & stateName, GameState * state ) = 0;
 
-  /*! Find a game state by name. @Remarks returns 0 on failure. */
+  /*! Find a game state by name. \Remarks returns 0 on failure. */
   virtual GameState * findByName( const std::string & stateName) = 0;
 
   /*! Request a change to state. */
@@ -196,4 +209,4 @@
 
 }  // namespace OpenGate{
 
-#endif // GAMESTATELISTENER__H
+#endif // _OPENGATE_GAMESTATELISTENER__H

Modified: branches/ogsector/src/GameStateManager.h
===================================================================
--- branches/ogsector/src/GameStateManager.h	2007-05-17 18:41:36 UTC (rev 475)
+++ branches/ogsector/src/GameStateManager.h	2007-05-17 19:01:55 UTC (rev 476)
@@ -32,57 +32,55 @@
 class InputManager;
 class VesselManager;
 
-//! \class GameStateManager
-/*! The GameStateManager manages changes in the game states
-    in the game.  It holds a stack of all open game states
-    and maps all events. */
+/*!
+ * \brief The class defines the gamestate manager.
 
+ * The GameStateManager manages changes in the game states in the game. It holds
+ * a list of all open game states and maps all events.
+ * \author Carsten <spo...@us...>
+ */
 class GameStateManager : public GameStateListener {
 public:
-  
-  /** Holds information about the states in order to
-      manage them properly and provide access. */
+
+  /*! \brief Holds information about the states in order to manage them properly and provide access. */
   typedef struct {
     std::string name;
     GameState * state;
   } StateInfo;
 
+  /*! Constructor */
   GameStateManager( NetworkClient & nw, bool dialog );
 
-  /** Cleans up the states before the instance dies. */
+  /*! Destructor that cleans up the states before the instance dies. */
   ~GameStateManager();
 
-  /** Store a game state to manage. */
+  /*! Store a game state to manage. */
   void manageGameState( const std::string & stateName, GameState * state );
 
-  /*!  Start game state. This is used to start the game state  manager functioning with a particular state. 
-    This function also does the main game loop and takes care of the Windows message pump.*/
+  /*!  Start game state. This is used to start the game state  manager functioning with a particular state. This function also does the main game loop and takes care of the Windows message pump.*/
   void start( GameState * state );
 
-  /*! Find a game state by name. @Remarks returns 0 on failure. */
+  /*! Find a game state by name. \Remarks returns 0 on failure. */
   virtual GameState * findByName( const std::string & stateName);
 
-  /*! Change to a game state. This replaces the current game state with a new game state.  
-    The current game state ends before the new begins. */
+  /*! Change to a game state. This replaces the current game state with a new game state. The current game state ends before the new begins. */
   void changeGameState( GameState * state );
-  
-  /*! Push a game state onto the stack. This pauses the current game state
-    and begins a new game state. If the current game state refuses to
-    be paused, this will return false. */
+
+  /*! Push a game state onto the stack. This pauses the current game state and begins a new game state. If the current game state refuses to be paused, this will return false. */
   bool pushGameState( GameState * state );
-  
-  /*! Pop a game state off the stack. This destroys the current game state
-    and returns control to the previous game state. */
+
+  /*! Pop a game state off the stack. This destroys the current game state and returns control to the previous game state. */
   void popGameState( );
-  
-  /** This is a special case function to cause a shutdown. */
+
+  /*! This is a special case function to cause a shutdown. */
   void shutdown( );
 
 protected:
-  /** This initializes a state to receive the events. */
+
+  /*! This initializes a state to receive the events. */
   void init_( GameState * state );
 
-  /** This removes event handling from a previous state. */
+  /*! This removes event handling from a previous state. */
   void cleanup_( GameState * state );
 
   bool initialiseDevices_( bool dialog );
@@ -99,11 +97,11 @@
   std::vector< StateInfo > states_;
 
   DeviceInfo devices_;
-  /** If this is set to true, the game state manager prepares to exit. */
+  /*! If this is set to true, the game state manager prepares to exit. */
   bool shutdownRequest_;
 };
 
-} // namespace OpenGate 
+} // namespace OpenGate
 
 
 #endif // GAMESTATEMANAGER__H

Modified: branches/ogsector/src/InputManager.cpp
===================================================================
--- branches/ogsector/src/InputManager.cpp	2007-05-17 18:41:36 UTC (rev 475)
+++ branches/ogsector/src/InputManager.cpp	2007-05-17 19:01:55 UTC (rev 476)
@@ -289,9 +289,9 @@
   return true;
 }
 
-InputManager & InputManager::getSingleton( ){  
-  assert( ms_Singleton );  
-  return ( *ms_Singleton );  
+InputManager & InputManager::getSingleton( ){
+  assert( ms_Singleton );
+  return ( *ms_Singleton );
 }
 
 InputManager * InputManager::getSingletonPtr( ){

Modified: branches/ogsector/src/InputManager.h
===================================================================
--- branches/ogsector/src/InputManager.h	2007-05-17 18:41:36 UTC (rev 475)
+++ branches/ogsector/src/InputManager.h	2007-05-17 19:01:55 UTC (rev 476)
@@ -18,8 +18,8 @@
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef INPUTMANAGER_H // INPUTMANAGER_H
-#define INPUTMANAGER_H
+#ifndef _OPENGATE_INPUTMANAGER__H
+#define _OPENGATE_INPUTMANAGER__H
 
 #ifdef WIN32
 #define OIS_WIN32_PLATFORM
@@ -44,22 +44,32 @@
 
 namespace OpenGate{
 
+/*!
+ * \brief This class handles all the user input via keyboard, mouse, joystick.
+ *
+ * \author Carsten <spo...@us...>
+ */
 class InputManager : public Ogre::Singleton< InputManager >,
-		     public OIS::KeyListener, 
-		     public OIS::MouseListener, 
+		     public OIS::KeyListener,
+		     public OIS::MouseListener,
 		     public OIS::JoyStickListener {
 public:
-  InputManager( ); 
 
+  /*! Constructor */
+  InputManager( );
+
+  /*! Destructor */
   virtual ~InputManager();
 
-  void init( unsigned long hWnd ); 
-  
+  /*! Initialize the OIS based input system */
+  void init( unsigned long hWnd );
+
+  /*! This tells the mouse how large a window is so that it stays inside \todo This has to be called after the window was resized */
   void setWindowExtents( int width, int height ) ;
 
-  /*! Need to capture / update each device every frame. */
+  /*! We need to capture/update each device every frame. */
   void capture();
-  
+
   void addKeyListener( OIS::KeyListener *keyListener, const std::string& instanceName );
   void addMouseListener( OIS::MouseListener *mouseListener, const std::string& instanceName );
   void addJoystickListener( OIS::JoyStickListener *joystickListener, const std::string& instanceName );
@@ -77,15 +87,16 @@
   void removeAllMouseListeners( void );
   void removeAllJoystickListeners( void );
 
-  // KeyListener
+  /*! KeyListener: key pressed event */
   bool keyPressed(const OIS::KeyEvent & e);
+  /*! KeyListener: key released event */
   bool keyReleased(const OIS::KeyEvent & e);
 
   // MouseListener
   bool mouseMoved(const OIS::MouseEvent & e);
   bool mousePressed(const OIS::MouseEvent & e, OIS::MouseButtonID);
   bool mouseReleased(const OIS::MouseEvent & e, OIS::MouseButtonID);
-  
+
   // JoyStickListener
   bool axisMoved(const OIS::JoyStickEvent & e, int index );
   bool buttonPressed(const OIS::JoyStickEvent & e, int index );
@@ -119,6 +130,6 @@
 
 };
 
-} // namespace OpenGate{
+} // namespace OpenGate
 
-#endif // INPUTMANAGER_H
+#endif // _OPENGATE_INPUTMANAGER__H

Modified: branches/ogsector/src/networkServer.h
===================================================================
--- branches/ogsector/src/networkServer.h	2007-05-17 18:41:36 UTC (rev 475)
+++ branches/ogsector/src/networkServer.h	2007-05-17 19:01:55 UTC (rev 476)
@@ -18,8 +18,8 @@
  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  ***************************************************************************/
 
-#ifndef NETWORKSERVER__H
-#define NETWORKSERVER__H
+#ifndef _OPENGATE_NETWORKSERVER__H
+#define _OPENGATE_NETWORKSERVER__H
 
 #include <set>
 #include <map>
@@ -96,6 +96,6 @@
   LogManager * log_;
 };
 
-} // namespace OpenGate 
+} // namespace OpenGate
 
-#endif //NETWORKSERVER__H
+#endif //_OPENGATE_NETWORKSERVER__H


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




2006	Jan	Feb	Mar (11)	Apr (47)	May (14)	Jun	Jul (73)	Aug (4)	Sep (2)	Oct (60)	Nov (48)	Dec (66)
2007	Jan	Feb (1)	Mar (27)	Apr (82)	May (89)	Jun (91)	Jul (44)	Aug (53)	Sep (113)	Oct (20)	Nov (37)	Dec (10)
2008	Jan	Feb (2)	Mar	Apr (2)	May (21)	Jun (3)	Jul	Aug	Sep	Oct	Nov	Dec (1)
2009	Jan (76)	Feb (89)	Mar (52)	Apr (11)	May (1)	Jun	Jul	Aug	Sep (1)	Oct	Nov	Dec (27)
2010	Jan (11)	Feb	Mar	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec
2011	Jan	Feb	Mar	Apr	May	Jun	Jul (1)	Aug (9)	Sep	Oct	Nov	Dec (14)
2012	Jan	Feb	Mar	Apr	May	Jun	Jul (1)	Aug (2)	Sep (11)	Oct (3)	Nov	Dec
2013	Jan (4)	Feb	Mar (2)	Apr	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec

opengate-svn Mailing List for Open Jumpgate (Page 31)

Opengate is a Jumpgate remake

opengate-svn — List for Subversion commits