[Orxonox-commit 2595] r7300 - in code/branches/doc/src: . libraries/core libraries/network orxonox/collisionshapes orxonox/controllers
landauf at orxonox.net
landauf at orxonox.net
Tue Aug 31 23:19:49 CEST 2010
Author: landauf
Date: 2010-08-31 23:19:49 +0200 (Tue, 31 Aug 2010)
New Revision: 7300
Modified:
code/branches/doc/src/OrxonoxConfig.h.in
code/branches/doc/src/SpecialConfig.h.in
code/branches/doc/src/libraries/core/Identifier.h
code/branches/doc/src/libraries/core/MemoryArchive.cc
code/branches/doc/src/libraries/network/GamestateClient.cc
code/branches/doc/src/orxonox/collisionshapes/CollisionShape.cc
code/branches/doc/src/orxonox/controllers/ArtificialController.cc
Log:
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)
Modified: code/branches/doc/src/OrxonoxConfig.h.in
===================================================================
--- code/branches/doc/src/OrxonoxConfig.h.in 2010-08-31 21:04:10 UTC (rev 7299)
+++ code/branches/doc/src/OrxonoxConfig.h.in 2010-08-31 21:19:49 UTC (rev 7300)
@@ -144,10 +144,7 @@
/*---------------------------------
* Options
*-------------------------------*/
-/**
- at def ORXONOX_RELEASE
- Enables expensive (build time) optimisations and disables certain features
-*/
+/// Enables expensive (build time) optimisations and disables certain features
#cmakedefine ORXONOX_RELEASE
Modified: code/branches/doc/src/SpecialConfig.h.in
===================================================================
--- code/branches/doc/src/SpecialConfig.h.in 2010-08-31 21:04:10 UTC (rev 7299)
+++ code/branches/doc/src/SpecialConfig.h.in 2010-08-31 21:19:49 UTC (rev 7300)
@@ -42,30 +42,16 @@
#include "OrxonoxConfig.h"
#include <boost/preprocessor/stringize.hpp>
-/**
- at def CEGUILUA_USE_INTERNAL_LIBRARY
- Set whether we must suffix "ceguilua/" for the CEGUILua.h include
-*/
+/// Set whether we must suffix "ceguilua/" for the CEGUILua.h include
#cmakedefine CEGUILUA_USE_INTERNAL_LIBRARY
-/**
- at def DEPENDENCY_PACKAGE_ENABLE
- Defined if a precompiled depdency package was used. We then copy all libraries
- too when installing.
-*/
+/// Defined if a precompiled depdency package was used. We then copy all libraries too when installing.
#cmakedefine DEPENDENCY_PACKAGE_ENABLE
-/**
- at def INSTALL_COPYABLE
- Orxonox either gets installed to the system or just into a folder.
- The latter uses relative paths.
-*/
+/// Orxonox either gets installed to the system or just into a folder. The latter uses relative paths.
#cmakedefine INSTALL_COPYABLE
-/**
- at def CMAKE_CONFIGURATION_TYPES
- Using MSVC or XCode IDE
-*/
+/// Using MSVC or XCode IDE
#cmakedefine CMAKE_CONFIGURATION_TYPES
// Handle default ConfigValues
@@ -125,10 +111,7 @@
#endif
} }
-/**
- at def ORXONOX_USE_WINMAIN
- Use main() or WinMain()?
-*/
+/// Use main() or WinMain()?
#cmakedefine ORXONOX_USE_WINMAIN
#endif /* _SpecialConfig_H__ */
Modified: code/branches/doc/src/libraries/core/Identifier.h
===================================================================
--- code/branches/doc/src/libraries/core/Identifier.h 2010-08-31 21:04:10 UTC (rev 7299)
+++ code/branches/doc/src/libraries/core/Identifier.h 2010-08-31 21:19:49 UTC (rev 7300)
@@ -302,8 +302,10 @@
template <class T>
class ClassIdentifier : public Identifier
{
+ #if true // doxygen workaround: doxygen ignores the following #include because of this #if, removes some warnings
#define SUPER_INTRUSIVE_DECLARATION_INCLUDE
#include "Super.h"
+ #endif
public:
static ClassIdentifier<T>* getIdentifier();
Modified: code/branches/doc/src/libraries/core/MemoryArchive.cc
===================================================================
--- code/branches/doc/src/libraries/core/MemoryArchive.cc 2010-08-31 21:04:10 UTC (rev 7299)
+++ code/branches/doc/src/libraries/core/MemoryArchive.cc 2010-08-31 21:19:49 UTC (rev 7300)
@@ -53,7 +53,7 @@
OGRE_EXCEPT(Ogre::Exception::ERR_INTERNAL_ERROR, this->getName() + " - MemoryArchive not found.", "MemoryArchive");
}
- DataStreamPtr MemoryArchive::open(const String& filename) const
+ DataStreamPtr MemoryArchive::open(const Ogre::String& filename) const
{
const FileMap& files = archives_s[this->getName()];
FileMap::const_iterator itFile = files.find(filename);
@@ -63,8 +63,8 @@
return MemoryDataStreamPtr(new MemoryDataStream(itFile->second.first.get(), itFile->second.second));
}
- void MemoryArchive::findFiles(const String& pattern, bool bRecursive,
- bool bDirs, StringVector* simpleList, FileInfoList* detailList)
+ void MemoryArchive::findFiles(const Ogre::String& pattern, bool bRecursive,
+ bool bDirs, Ogre::StringVector* simpleList, Ogre::FileInfoList* detailList)
{
const FileMap& files = archives_s[this->getName()];
@@ -109,7 +109,7 @@
return ret;
}
- StringVectorPtr MemoryArchive::find(const String& pattern,
+ StringVectorPtr MemoryArchive::find(const Ogre::String& pattern,
bool recursive, bool dirs)
{
StringVectorPtr ret(new StringVector());
@@ -117,7 +117,7 @@
return ret;
}
- FileInfoListPtr MemoryArchive::findFileInfo(const String& pattern,
+ FileInfoListPtr MemoryArchive::findFileInfo(const Ogre::String& pattern,
bool recursive, bool dirs)
{
FileInfoListPtr ret(new FileInfoList());
@@ -125,7 +125,7 @@
return ret;
}
- bool MemoryArchive::exists(const String& filename)
+ bool MemoryArchive::exists(const Ogre::String& filename)
{
const FileMap& files = archives_s[this->getName()];
return files.find(filename) != files.end();
Modified: code/branches/doc/src/libraries/network/GamestateClient.cc
===================================================================
--- code/branches/doc/src/libraries/network/GamestateClient.cc 2010-08-31 21:04:10 UTC (rev 7299)
+++ code/branches/doc/src/libraries/network/GamestateClient.cc 2010-08-31 21:19:49 UTC (rev 7300)
@@ -104,8 +104,8 @@
* @param it iterator of the list pointing to the object
* @return iterator pointing to the next object in the list
*/
- void GamestateClient::removeObject(ObjectList<Synchronisable>::iterator &it) {
- ObjectList<Synchronisable>::iterator temp=it;
+ void GamestateClient::removeObject(ObjectListIterator<Synchronisable> &it) {
+ ObjectListIterator<Synchronisable> temp=it;
++it;
temp->destroy(); // or delete?
}
Modified: code/branches/doc/src/orxonox/collisionshapes/CollisionShape.cc
===================================================================
--- code/branches/doc/src/orxonox/collisionshapes/CollisionShape.cc 2010-08-31 21:04:10 UTC (rev 7299)
+++ code/branches/doc/src/orxonox/collisionshapes/CollisionShape.cc 2010-08-31 21:19:49 UTC (rev 7300)
@@ -149,7 +149,7 @@
delete oldShape;
}
- void CollisionShape::calculateLocalInertia(btScalar mass, btVector3& inertia) const
+ void CollisionShape::calculateLocalInertia(float mass, btVector3& inertia) const
{
if (this->collisionShape_)
this->collisionShape_->calculateLocalInertia(mass, inertia);
Modified: code/branches/doc/src/orxonox/controllers/ArtificialController.cc
===================================================================
--- code/branches/doc/src/orxonox/controllers/ArtificialController.cc 2010-08-31 21:04:10 UTC (rev 7299)
+++ code/branches/doc/src/orxonox/controllers/ArtificialController.cc 2010-08-31 21:19:49 UTC (rev 7300)
@@ -557,7 +557,7 @@
}
/**
- @brief Master sets its slaves free for @var FREEDOM_COUNT seconds.
+ @brief Master sets its slaves free for @ref FREEDOM_COUNT seconds.
*/
void ArtificialController::forceFreeSlaves()
{
More information about the Orxonox-commit
mailing list