Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7804


Ignore:
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:
4 edited

Legend:

Unmodified
Added
Removed

  • code/trunk/src/libraries/network/MasterServerComm.h

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

  • code/trunk/src/orxonox/LevelInfo.h

    r7802 r7804  
    5050    /**
    5151    @brief
    52         The LevelInfoItem class stores information regarding a @ref orxonox::Level "Level" and makes that information it accessible trough the @ref orxonox::LevelManager "LevelManager".
     52        The LevelInfoItem class stores information regarding a @ref orxonox::Level "Level" and makes that information accessible through the @ref orxonox::LevelManager "LevelManager".
    5353        A LevelInfoItem object is commonly created from a @ref orxonox::LevelInfo "LevelInfo" object, using its <code>copy()</code> method.
    5454
    5555    @author
    5656        Damian 'Mozork' Frick
     57
     58    @ingroup Orxonox
    5759    */
    5860    class _OrxonoxExport LevelInfoItem // tolua_export
    … …  
    160162    @author
    161163        Damian 'Mozork' Frick
     164
     165    @ingroup Orxonox
    162166    */
    163167    class _OrxonoxExport LevelInfo : public BaseObject, public LevelInfoItem
    … …  
    202206    @brief
    203207        Struct that overloads the compare operation between two @ref orxonox::LevelInfoItem "LevelInfoItem" pointers.
     208
     209    @ingroup Orxonox
    204210    */
    205211    struct LevelInfoCompare

  • code/trunk/src/orxonox/LevelManager.cc

    r7802 r7804  
    2626 *
    2727 */
     28
     29/**
     30    @file LevelManager.cc
     31    @brief Implementation of the LevelManager singleton.
     32*/
    2833
    2934#include "LevelManager.h"
    … …  
    187192        The LevelInfoItems are sorted in alphabetical order accoridng to the name of the Level.
    188193        This method is most efficiently called with consecutive indices (or at least ascending indices).
     194    @param index
     195        The index of the item that should be returned.
    189196    @return
    190197        Returns a pointer to the LevelInfoItem at the given index.
    … …  
    192199    LevelInfoItem* LevelManager::getAvailableLevelListItem(unsigned int index)
    193200    {
    194         if (index >= this->availableLevels_.size())
     201        if(index >= this->availableLevels_.size())
    195202            return NULL;
    196203

  • code/trunk/src/orxonox/LevelManager.h

    r7803 r7804  
    2626 *
    2727 */
     28
     29/**
     30    @file LevelManager.h
     31    @brief Definition of the LevelManager singleton.
     32    @ingroup Orxonox
     33*/
    2834
    2935#ifndef _LevelManager_H__
    … …  
    5662    @author
    5763        Damian 'Mozork' Frick
     64
     65    @ingroup Orxonox
    5866    */
    5967    class _OrxonoxExport LevelManager
Note: See TracChangeset for help on using the changeset viewer.