Changeset 7300 for code/branches/doc/src/libraries

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/libraries

Files:

• core/Identifier.h (modified) (1 diff)
• core/MemoryArchive.cc (modified) (5 diffs)
• network/GamestateClient.cc (modified) (1 diff)

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

@@ -303 +303 @@
     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:

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

@@ -54 +54 @@
     }
 
-    DataStreamPtr MemoryArchive::open(const String& filename) const
+    DataStreamPtr MemoryArchive::open(const Ogre::String& filename) const
     {
         const FileMap& files = archives_s[this->getName()];
@@ -64 +64 @@
     }
 
-    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()];
@@ -110 +110 @@
     }
 
-    StringVectorPtr MemoryArchive::find(const String& pattern,
+    StringVectorPtr MemoryArchive::find(const Ogre::String& pattern,
                                             bool recursive, bool dirs)
     {
@@ -118 +118 @@
     }
 
-    FileInfoListPtr MemoryArchive::findFileInfo(const String& pattern,
+    FileInfoListPtr MemoryArchive::findFileInfo(const Ogre::String& pattern,
         bool recursive, bool dirs)
     {
@@ -126 +126 @@
     }
 
-    bool MemoryArchive::exists(const String& filename)
+    bool MemoryArchive::exists(const Ogre::String& filename)
     {
         const FileMap& files = archives_s[this->getName()];

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

@@ -105 +105 @@
   * @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?