Changeset 7804 for code/trunk/src/orxonox/LevelManager.cc

Timestamp:

Dec 25, 2010, 9:32:34 PM (14 years ago)

Author:

dafrick

Message:

Some more minor changes in documentation.

File:

• code/trunk/src/orxonox/LevelManager.cc (modified) (3 diffs)

code/trunk/src/orxonox/LevelManager.cc

@@ -26 +26 @@
  *
  */
+
+/**
+    @file LevelManager.cc
+    @brief Implementation of the LevelManager singleton.
+*/
 
 #include "LevelManager.h"
@@ -187 +192 @@
         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.
@@ -192 +199 @@
     LevelInfoItem* LevelManager::getAvailableLevelListItem(unsigned int index)
     {
-        if (index >= this->availableLevels_.size())
+        if(index >= this->availableLevels_.size())
             return NULL;