Context Navigation

Changeset 7804 for code/trunk

Timestamp:

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

Author:

dafrick

Message:

Some more minor changes in documentation.

Location:

code/trunk/src

Files:

r7801	r7804
88	88	int sendRequest( std::string data );
89	89
90		/** \param callback The callback function to call with data receivced.
	90	/** \param callback The callback function to call with data received.
91	91	* \return 0 for success, other for error
92	92	*

-                      r7802
+                      r7804
     /**
     @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
 …
     @author
         Damian 'Mozork' Frick
+    @ingroup Orxonox
     */
     class _OrxonoxExport LevelInfo : public BaseObject, public LevelInfoItem
 …
     @brief
         Struct that overloads the compare operation between two @ref orxonox::LevelInfoItem "LevelInfoItem" pointers.
+    @ingroup Orxonox
     */
     struct LevelInfoCompare

-                      r7802
+                      r7804
+ *
  */
+/**
+    @file LevelManager.cc
+    @brief Implementation of the LevelManager singleton.
+*/
 #include "LevelManager.h"
 …
         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;

-                      r7803
+                      r7804
+ *
  */
+/**
+    @file LevelManager.h
+    @brief Definition of the LevelManager singleton.
+    @ingroup Orxonox
+*/
 #ifndef _LevelManager_H__
 …
     @author
         Damian 'Mozork' Frick
+    @ingroup Orxonox
     */
     class _OrxonoxExport LevelManager

Note: See TracChangeset for help on using the changeset viewer.