Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Jan 27, 2016, 6:50:51 PM (9 years ago)
Author:
muemart
Message:

Fix loads of doxygen warnings and other documentation issues

Location:
code/trunk/src/libraries
Files:
22 edited

Legend:

Unmodified
Added
Removed

  • code/trunk/src/libraries/core/CoreIncludes.h

    r11071 r11099  
    125125    @brief Registers the class in the framework with a given Factory.
    126126    @param ClassName The name of the class
     127    @param FactoryInstance An instance of a factory that can create the class
     128    @param bLoadable Whether the class is allowed to be loaded through XML
    127129*/
    128130#define RegisterClassWithFactory(ClassName, FactoryInstance, bLoadable) \
    … …  
    201203        @note This of course only works with Identifiables.
    202204              The only use is in conjunction with macros that don't know the class type.
    203         @param object Pointer to an Identifiable
     205        @param p Pointer to an Identifiable
    204206    */
    205207    template <class T>
    206     inline Identifier* ClassByObjectType(const T*)
     208    inline Identifier* ClassByObjectType(const T* p)
    207209    {
    208210        return ClassIdentifier<T>::getIdentifier();

  • code/trunk/src/libraries/core/GUIManager.cc

    r11083 r11099  
    793793    }
    794794
    795     /** Executes a CEGUI function normally, but catches CEGUI::ScriptException.
     795    /**
     796    @copydoc protectedCeguiSystemCall
     797    @param function
     798        Any callable object/function that takes one parameter.
     799    @param object
     800        Object to be used as an argument for the @p function
     801    @return
     802        True if input was handled, false otherwise. A caught exception yields true.
     803    */
     804    template <typename FunctionType, typename ObjectType>
     805    bool GUIManager::protectedCall(FunctionType function, ObjectType object)
     806    {
     807        try
     808        {
     809            return function(object);
     810        }
     811        catch (CEGUI::ScriptException& ex)
     812        {
     813            // Display the error and proceed. See @remarks why this can be dangerous.
     814            orxout(internal_error) << ex.getMessage() << endl;
     815            return true;
     816        }
     817    }
     818
     819    /**
     820        Executes a CEGUI function normally, but catches CEGUI::ScriptException.
    796821        When a ScriptException occurs, the error message will be displayed and
    797822        the program carries on.
    … …  
    808833        True if input was handled, false otherwise. A caught exception yields true.
    809834    */
    810     template <typename FunctionType, typename ObjectType>
    811     bool GUIManager::protectedCall(FunctionType function, ObjectType object)
    812     {
    813         try
    814         {
    815             return function(object);
    816         }
    817         catch (CEGUI::ScriptException& ex)
    818         {
    819             // Display the error and proceed. See @remarks why this can be dangerous.
    820             orxout(internal_error) << ex.getMessage() << endl;
    821             return true;
    822         }
    823     }
    824 
    825835    template <typename FunctionType>
    826836    bool GUIManager::protectedCeguiSystemCall(FunctionType function)

  • code/trunk/src/libraries/core/class/IdentifierManager.cc

    r11071 r11099  
    255255    /**
    256256        @brief Returns the Identifier with a given typeid-name.
    257         @param name The typeid-name of the wanted Identifier
     257        @param typeInfo The type_info of the wanted Identifier
    258258        @return The Identifier
    259259    */

  • code/trunk/src/libraries/core/command/CommandExecutor.cc

    r11071 r11099  
    6767        @param command A string containing the command
    6868        @param useTcl If true, the command is passed to tcl (see TclBind)
     69        @param printErrors If true, print an error when command failed
    6970        @return Returns the error-code (see @ref CommandExecutorErrorCodes "error codes")
    7071    */

  • code/trunk/src/libraries/core/command/ConsoleCommandCompilation.cc

    r10624 r11099  
    100100        @brief Prints text to the console.
    101101        @param level_name The name of the output level
     102        @param text The text to print
    102103    */
    103104    void orxout_level(const std::string& level_name, const std::string& text)
    … …  
    119120        @param level_name The name of the output level
    120121        @param context_name The name of the output context
     122        @param text The text to print
    121123    */
    122124    void orxout_level_context(const std::string& level_name, const std::string& context_name, const std::string& text)

  • code/trunk/src/libraries/core/commandline/CommandLineIncludes.h

    r11071 r11099  
    3030    @defgroup CmdArgs Commandline arguments
    3131    @ingroup Config
    32     @brief For a reference of all commandline arguments see @ref cmdargspage
    3332*/
    3433

  • code/trunk/src/libraries/core/commandline/CommandLineParser.cc

    r11071 r11099  
    218218    @param value
    219219        String containing the value
    220     @param bParsingFile
    221         Parsing a file or the command line itself
    222220    */
    223221    void CommandLineParser::checkFullArgument(const std::string& name, const std::string& value)
    … …  
    237235    @param value
    238236        String containing the value
    239     @param bParsingFile
    240         Parsing a file or the command line itself
    241237    */
    242238    void CommandLineParser::checkShortcut(const std::string& shortcut, const std::string& value)

  • code/trunk/src/libraries/core/commandline/CommandLineParser.h

    r11071 r11099  
    2626 *
    2727 */
    28 
    29 /**
    30     @defgroup CmdArgs Commandline arguments
    31     @ingroup Config
    32     @brief For a reference of all commandline arguments see @ref cmdargspage
    33 */
    3428
    3529/**

  • code/trunk/src/libraries/core/config/ConfigValueContainer.h

    r11071 r11099  
    109109            */
    110110            template <class D, class V>
    111             ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const D& defvalue, const V&)
     111            ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const D& defvalue, const V& value)
    112112            {
    113113                this->init(type, identifier, sectionname, varname);
    … …  
    125125            */
    126126            template <class D, class V>
    127             ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const std::vector<D>& defvalue, const std::vector<V>&)
     127            ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const std::vector<D>& defvalue, const std::vector<V>& value)
    128128            {
    129129                this->init(type, identifier, sectionname, varname);

  • code/trunk/src/libraries/core/object/IteratorBase.h

    r11071 r11099  
    173173            /**
    174174                @brief Increments the Iterator if it points at the given element.
    175                 @param object The object to compare with
     175                @param element The element to compare with
    176176            */
    177177            virtual void removedElement(ObjectListBaseElement* element) override

  • code/trunk/src/libraries/core/object/ObjectListBase.h

    r11071 r11099  
    5555            /**
    5656                @brief Constructor: Creates the list-element with an object.
    57                 @param objectBase The object to store
     57                @param object The object to store
    5858            */
    5959            ObjectListBaseElement(Listable* object) : next_(nullptr), prev_(nullptr), objectBase_(object), list_(nullptr) {}

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

    r8858 r11099  
    8888      int sendRequest( std::string data );
    8989
    90       /** \param callback The callback function to call with data received.
     90      /** \param listener The listener to call with data received.
    9191       *  \param delayms Delay in milliseconds.
    9292       * \return 0 for success, other for error

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

    r10622 r11099  
    7474      /* BASIC MANIPULATION */
    7575      /** \param toadd the server to add.
     76       *  \param peer the peer
    7677       *
    7778       * Add server to the game server list

  • code/trunk/src/libraries/tools/BulletDebugDrawer.cc

    r10277 r11099  
    11/**
     2 * @file BulletDebugDrawer.cc
    23 * Originally from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
    34 * This source code is released into the Public Domain.

  • code/trunk/src/libraries/tools/BulletDebugDrawer.h

    r11071 r11099  
    1 /**
    2  * Originally from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
    3  * This source code is released into the Public Domain.
    4  *
    5  * Modified by Fabian 'x3n' Landau by using DebugDrawer and Orxonox specific utilities (e.g. output).
    6  */
    7 
    81#ifndef _BulletDebugDrawer_H__
    92#define _BulletDebugDrawer_H__
    … …  
    1811namespace orxonox
    1912{
     13    /**
     14    * Originally from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
     15    * This source code is released into the Public Domain.
     16    *
     17    * Modified by Fabian 'x3n' Landau by using DebugDrawer and Orxonox specific utilities (e.g. output).
     18    */
    2019    class _ToolsExport BulletDebugDrawer : public btIDebugDraw, public Ogre::FrameListener
    2120    {

  • code/trunk/src/libraries/tools/DebugDrawer.cc

    r11071 r11099  
    11/**
     2 * @file DebugDrawer.cc
    23 * Copy-pasted from
    34 *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src

  • code/trunk/src/libraries/tools/DebugDrawer.h

    r10262 r11099  
    11/**
     2 * @file DebugDrawer.h
    23 * Copy-pasted from
    34 *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
    … …  
    910 */
    1011
    11 /**
    12  * @file
    13  * @brief DebugDrawer is a utility to draw debug shapes (lines, triangles, spheres) with Ogre.
    14  * This utility is e.g. used by @ref BulletDebugDrawer to visualize collision shapes and other physical entities.
    15  */
     12
    1613
    1714#ifndef _DebugDrawer_H__
    … …  
    2623namespace orxonox
    2724{
     25    /**
     26     * @brief DebugDrawer is a utility to draw debug shapes (lines, triangles, spheres) with Ogre.
     27     * This utility is e.g. used by @ref orxonox::BulletDebugDrawer to visualize collision shapes and other physical entities.
     28     */
    2829    class _ToolsExport DebugDrawer
    2930    {

  • code/trunk/src/libraries/tools/IcoSphere.cc

    r11071 r11099  
    11/**
     2 * @file IcoSphere.cc
    23 * Copy-pasted from
    34 *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src

  • code/trunk/src/libraries/tools/IcoSphere.h

    r10262 r11099  
    1 /**
    2  * Copy-pasted from
    3  *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
    4  *  - http://www.ogre3d.org/tikiwiki/tiki-index.php?page=Debug+Drawing+Utility+Class
    5  *
    6  * This source code is released into the Public Domain.
    7  *
    8  * Modified by Fabian 'x3n' Landau
    9  */
    101
    11 /**
    12  * @file
    13  * @brief DebugDrawer is a utility to draw debug shapes (lines, triangles, spheres) with Ogre.
    14  * This utility is e.g. used by @ref BulletDebugDrawer to visualize collision shapes and other physical entities.
    15  */
    162
    173#ifndef _IcoSphere_H__
    … …  
    2713    typedef std::pair<Ogre::Vector3, Ogre::ColourValue> VertexPair;
    2814
     15    /**
     16    * Copy-pasted from
     17    *  - https://bitbucket.org/hasyimi/ogre-debug-drawing-utility/src
     18    *  - http://www.ogre3d.org/tikiwiki/tiki-index.php?page=Debug+Drawing+Utility+Class
     19    *
     20    * This source code is released into the Public Domain.
     21    *
     22    * Modified by Fabian 'x3n' Landau
     23    */
    2924    class _ToolsExport IcoSphere
    3025    {

  • code/trunk/src/libraries/tools/OgreBulletUtils.h

    r11071 r11099  
    11/**
     2 * @file OgreBulletUtils.h
    23 * Copy-pasted from http://www.ogre3d.org/tikiwiki/BulletDebugDrawer&structure=Cookbook
    34 * This source code is released into the Public Domain.

  • code/trunk/src/libraries/util/Clock.h

    r11071 r11099  
    5454        caveat because it will only capture the time on the same CPU core.
    5555        Confining the main thread to one process could speed up the game.
    56         See \ref cmdargspage "Ccommandline Argument" 'limitToCPU' (only on Windows)
    5756    */
    5857    class _UtilExport Clock

  • code/trunk/src/libraries/util/Math.cc

    r11071 r11099  
    291291    /**
    292292                @brief Gets the new vector after a coordinate transformation
    293                 @param distance Vector which will be transformed
    294                 @param mydirection New x basevector
    295                 @param myorthonormal New y basevector
    296                 @param otherposition New z basevector
    297                 @return direction in the new coordinates
     293                @param totransform Vector which will be transformed
     294                @param newx New x basevector
     295                @param newy New y basevector
     296                @param newz New z basevector
     297                @return Vector in the new coordinates
    298298
    299299                x is vector in old coordinates
    … …  
    307307                y = T^(-1)*x
    308308            */
    309     orxonox::Vector3 getTransformedVector(const orxonox::Vector3& distance, const orxonox::Vector3& mydirection, const orxonox::Vector3& myorthonormal, const orxonox::Vector3& myside)
     309    orxonox::Vector3 getTransformedVector(const orxonox::Vector3& totransform, const orxonox::Vector3& newx, const orxonox::Vector3& newy, const orxonox::Vector3& newz)
    310310    {
    311311        // inverse of the transform matrix
    312         float determinant = +mydirection.x * (myorthonormal.y*myside.z - myside.y*myorthonormal.z)
    313                             -mydirection.y * (myorthonormal.x*myside.z - myorthonormal.z*myside.x)
    314                             +mydirection.z * (myorthonormal.x*myside.y - myorthonormal.y*myside.x);
     312        float determinant = +newx.x * (newy.y*newz.z - newz.y*newy.z)
     313                            -newx.y * (newy.x*newz.z - newy.z*newz.x)
     314                            +newx.z * (newy.x*newz.y - newy.y*newz.x);
    315315        float invdet = 1/determinant;
    316316
    … …  
    320320        orxonox::Vector3 zinvtransform;
    321321
    322         xinvtransform.x = (myorthonormal.y * myside.z        - myside.y        * myorthonormal.z)*invdet;
    323         xinvtransform.y = (mydirection.z   * myside.y        - mydirection.y   * myside.z       )*invdet;
    324         xinvtransform.z = (mydirection.y   * myorthonormal.z - mydirection.z   * myorthonormal.y)*invdet;
    325         yinvtransform.x = (myorthonormal.z * myside.x        - myorthonormal.x * myside.z       )*invdet;
    326         yinvtransform.y = (mydirection.x   * myside.z        - mydirection.z   * myside.x       )*invdet;
    327         yinvtransform.z = (myorthonormal.x * mydirection.z   - mydirection.x   * myorthonormal.z)*invdet;
    328         zinvtransform.x = (myorthonormal.x * myside.y        - myside.x        * myorthonormal.y)*invdet;
    329         zinvtransform.y = (myside.x        * mydirection.y   - mydirection.x   * myside.y       )*invdet;
    330         zinvtransform.z = (mydirection.x   * myorthonormal.y - myorthonormal.x * mydirection.y  )*invdet;
     322        xinvtransform.x = (newy.y * newz.z        - newz.y        * newy.z)*invdet;
     323        xinvtransform.y = (newx.z   * newz.y        - newx.y   * newz.z       )*invdet;
     324        xinvtransform.z = (newx.y   * newy.z - newx.z   * newy.y)*invdet;
     325        yinvtransform.x = (newy.z * newz.x        - newy.x * newz.z       )*invdet;
     326        yinvtransform.y = (newx.x   * newz.z        - newx.z   * newz.x       )*invdet;
     327        yinvtransform.z = (newy.x * newx.z   - newx.x   * newy.z)*invdet;
     328        zinvtransform.x = (newy.x * newz.y        - newz.x        * newy.y)*invdet;
     329        zinvtransform.y = (newz.x        * newx.y   - newx.x   * newz.y       )*invdet;
     330        zinvtransform.z = (newx.x   * newy.y - newy.x * newx.y  )*invdet;
    331331
    332332        // coordinate transformation
    333333        orxonox::Vector3 distanceShip;
    334         distanceShip.x = xinvtransform.x * distance.x + yinvtransform.x * distance.y + zinvtransform.x * distance.z;
    335         distanceShip.y = xinvtransform.y * distance.x + yinvtransform.y * distance.y + zinvtransform.y * distance.z;
    336         distanceShip.z = xinvtransform.z * distance.x + yinvtransform.z * distance.y + zinvtransform.z * distance.z;
     334        distanceShip.x = xinvtransform.x * totransform.x + yinvtransform.x * totransform.y + zinvtransform.x * totransform.z;
     335        distanceShip.y = xinvtransform.y * totransform.x + yinvtransform.y * totransform.y + zinvtransform.y * totransform.z;
     336        distanceShip.z = xinvtransform.z * totransform.x + yinvtransform.z * totransform.y + zinvtransform.z * totransform.z;
    337337
    338338        return distanceShip;
Note: See TracChangeset for help on using the changeset viewer.