Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 7300 for code/branches/doc


Ignore:
Timestamp:
Aug 31, 2010, 11:19:49 PM (14 years ago)
Author:
landauf
Message:

fixed the remaining doxygen warnings.

there are still 3 possible cases which produce a warning, but I can't fix them and they are all irrelevant:

  • if you declare an argument completion function
  • if you use an argument completion function
  • if you declare a console command and pass a value which contains "::" (for example KeybindMode::OnHold or AccessLevel::Master)
Location:
code/branches/doc/src
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • code/branches/doc/src/OrxonoxConfig.h.in

    r5695 r7300  
    145145 * Options
    146146 *-------------------------------*/
    147 /**
    148 @def ORXONOX_RELEASE
    149     Enables expensive (build time) optimisations and disables certain features
    150 */
     147/// Enables expensive (build time) optimisations and disables certain features
    151148#cmakedefine ORXONOX_RELEASE
    152149

  • code/branches/doc/src/SpecialConfig.h.in

    r5781 r7300  
    4343#include <boost/preprocessor/stringize.hpp>
    4444
    45 /**
    46 @def CEGUILUA_USE_INTERNAL_LIBRARY
    47     Set whether we must suffix "ceguilua/" for the CEGUILua.h include
    48 */
     45/// Set whether we must suffix "ceguilua/" for the CEGUILua.h include
    4946#cmakedefine CEGUILUA_USE_INTERNAL_LIBRARY
    5047
    51 /**
    52 @def DEPENDENCY_PACKAGE_ENABLE
    53     Defined if a precompiled depdency package was used. We then copy all libraries
    54     too when installing.
    55 */
     48/// Defined if a precompiled depdency package was used. We then copy all libraries too when installing.
    5649#cmakedefine DEPENDENCY_PACKAGE_ENABLE
    5750
    58 /**
    59 @def INSTALL_COPYABLE
    60     Orxonox either gets installed to the system or just into a folder.
    61     The latter uses relative paths.
    62 */
     51/// Orxonox either gets installed to the system or just into a folder. The latter uses relative paths.
    6352#cmakedefine INSTALL_COPYABLE
    6453
    65 /**
    66 @def CMAKE_CONFIGURATION_TYPES
    67     Using MSVC or XCode IDE
    68 */
     54/// Using MSVC or XCode IDE
    6955#cmakedefine CMAKE_CONFIGURATION_TYPES
    7056
    … …  
    126112} }
    127113
    128 /**
    129 @def ORXONOX_USE_WINMAIN
    130     Use main() or WinMain()?
    131 */
     114/// Use main() or WinMain()?
    132115#cmakedefine ORXONOX_USE_WINMAIN
    133116

  • code/branches/doc/src/libraries/core/Identifier.h

    r7297 r7300  
    303303    class ClassIdentifier : public Identifier
    304304    {
     305        #if true // doxygen workaround: doxygen ignores the following #include because of this #if, removes some warnings
    305306        #define SUPER_INTRUSIVE_DECLARATION_INCLUDE
    306307        #include "Super.h"
     308        #endif
    307309
    308310        public:

  • code/branches/doc/src/libraries/core/MemoryArchive.cc

    r6417 r7300  
    5454    }
    5555
    56     DataStreamPtr MemoryArchive::open(const String& filename) const
     56    DataStreamPtr MemoryArchive::open(const Ogre::String& filename) const
    5757    {
    5858        const FileMap& files = archives_s[this->getName()];
    … …  
    6464    }
    6565
    66     void MemoryArchive::findFiles(const String& pattern, bool bRecursive,
    67         bool bDirs, StringVector* simpleList, FileInfoList* detailList)
     66    void MemoryArchive::findFiles(const Ogre::String& pattern, bool bRecursive,
     67        bool bDirs, Ogre::StringVector* simpleList, Ogre::FileInfoList* detailList)
    6868    {
    6969        const FileMap& files = archives_s[this->getName()];
    … …  
    110110    }
    111111
    112     StringVectorPtr MemoryArchive::find(const String& pattern,
     112    StringVectorPtr MemoryArchive::find(const Ogre::String& pattern,
    113113                                            bool recursive, bool dirs)
    114114    {
    … …  
    118118    }
    119119
    120     FileInfoListPtr MemoryArchive::findFileInfo(const String& pattern,
     120    FileInfoListPtr MemoryArchive::findFileInfo(const Ogre::String& pattern,
    121121        bool recursive, bool dirs)
    122122    {
    … …  
    126126    }
    127127
    128     bool MemoryArchive::exists(const String& filename)
     128    bool MemoryArchive::exists(const Ogre::String& filename)
    129129    {
    130130        const FileMap& files = archives_s[this->getName()];

  • code/branches/doc/src/libraries/network/GamestateClient.cc

    r7163 r7300  
    105105  * @return iterator pointing to the next object in the list
    106106  */
    107   void GamestateClient::removeObject(ObjectList<Synchronisable>::iterator &it) {
    108     ObjectList<Synchronisable>::iterator temp=it;
     107  void GamestateClient::removeObject(ObjectListIterator<Synchronisable> &it) {
     108    ObjectListIterator<Synchronisable> temp=it;
    109109    ++it;
    110110    temp->destroy(); // or delete?

  • code/branches/doc/src/orxonox/collisionshapes/CollisionShape.cc

    r5781 r7300  
    150150    }
    151151
    152     void CollisionShape::calculateLocalInertia(btScalar mass, btVector3& inertia) const
     152    void CollisionShape::calculateLocalInertia(float mass, btVector3& inertia) const
    153153    {
    154154        if (this->collisionShape_)

  • code/branches/doc/src/orxonox/controllers/ArtificialController.cc

    r7297 r7300  
    558558
    559559    /**
    560         @brief Master sets its slaves free for @var FREEDOM_COUNT seconds.
     560        @brief Master sets its slaves free for @ref FREEDOM_COUNT seconds.
    561561    */
    562562    void ArtificialController::forceFreeSlaves()
Note: See TracChangeset for help on using the changeset viewer.