[Orxonox-commit 3110] r7804 - in code/trunk/src: libraries/network orxonox

[dafrick at orxonox.net]

Author: dafrick
Date: 2010-12-25 21:32:34 +0100 (Sat, 25 Dec 2010)
New Revision: 7804

Modified:
   code/trunk/src/libraries/network/MasterServerComm.h
   code/trunk/src/orxonox/LevelInfo.h
   code/trunk/src/orxonox/LevelManager.cc
   code/trunk/src/orxonox/LevelManager.h
Log:
Some more minor changes in documentation.


Modified: code/trunk/src/libraries/network/MasterServerComm.h
===================================================================
--- code/trunk/src/libraries/network/MasterServerComm.h	2010-12-25 19:53:13 UTC (rev 7803)
+++ code/trunk/src/libraries/network/MasterServerComm.h	2010-12-25 20:32:34 UTC (rev 7804)
@@ -87,7 +87,7 @@
        */
       int sendRequest( std::string data );
 
-      /** \param callback The callback function to call with data receivced.
+      /** \param callback The callback function to call with data received.
        * \return 0 for success, other for error
        * 
        * Poll the master server for new data and act accordingly */

Modified: code/trunk/src/orxonox/LevelInfo.h
===================================================================
--- code/trunk/src/orxonox/LevelInfo.h	2010-12-25 19:53:13 UTC (rev 7803)
+++ code/trunk/src/orxonox/LevelInfo.h	2010-12-25 20:32:34 UTC (rev 7804)
@@ -49,11 +49,13 @@
 
     /**
     @brief
-        The LevelInfoItem class stores information regarding a @ref orxonox::Level "Level" and makes that information it accessible trough the @ref orxonox::LevelManager "LevelManager".
+        The LevelInfoItem class stores information regarding a @ref orxonox::Level "Level" and makes that information accessible through the @ref orxonox::LevelManager "LevelManager".
         A LevelInfoItem object is commonly created from a @ref orxonox::LevelInfo "LevelInfo" object, using its <code>copy()</code> method.
 
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Orxonox
     */
     class _OrxonoxExport LevelInfoItem // tolua_export
         : virtual public OrxonoxClass
@@ -159,6 +161,8 @@
 
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Orxonox
     */
     class _OrxonoxExport LevelInfo : public BaseObject, public LevelInfoItem
     {
@@ -201,6 +205,8 @@
     /**
     @brief
         Struct that overloads the compare operation between two @ref orxonox::LevelInfoItem "LevelInfoItem" pointers.
+
+    @ingroup Orxonox
     */
     struct LevelInfoCompare
     {

Modified: code/trunk/src/orxonox/LevelManager.cc
===================================================================
--- code/trunk/src/orxonox/LevelManager.cc	2010-12-25 19:53:13 UTC (rev 7803)
+++ code/trunk/src/orxonox/LevelManager.cc	2010-12-25 20:32:34 UTC (rev 7804)
@@ -26,6 +26,11 @@
  *
  */
 
+/**
+    @file LevelManager.cc
+    @brief Implementation of the LevelManager singleton.
+*/
+
 #include "LevelManager.h"
 
 #include <map>
@@ -186,12 +191,14 @@
         Get the LevelInfoItem at the given index in the list of available Levels.
         The LevelInfoItems are sorted in alphabetical order accoridng to the name of the Level.
         This method is most efficiently called with consecutive indices (or at least ascending indices).
+    @param index
+        The index of the item that should be returned.
     @return
         Returns a pointer to the LevelInfoItem at the given index.
     */
     LevelInfoItem* LevelManager::getAvailableLevelListItem(unsigned int index)
     {
-        if (index >= this->availableLevels_.size())
+        if(index >= this->availableLevels_.size())
             return NULL;
 
         // If this index directly follows the last we can optimize a lot.

Modified: code/trunk/src/orxonox/LevelManager.h
===================================================================
--- code/trunk/src/orxonox/LevelManager.h	2010-12-25 19:53:13 UTC (rev 7803)
+++ code/trunk/src/orxonox/LevelManager.h	2010-12-25 20:32:34 UTC (rev 7804)
@@ -26,6 +26,12 @@
  *
  */
 
+/**
+    @file LevelManager.h
+    @brief Definition of the LevelManager singleton.
+    @ingroup Orxonox
+*/
+
 #ifndef _LevelManager_H__
 #define _LevelManager_H__
 
@@ -55,6 +61,8 @@
 
     @author
         Damian 'Mozork' Frick
+
+    @ingroup Orxonox
     */
     class _OrxonoxExport LevelManager
     // tolua_end