[Orxonox-commit 2602] r7307 - in code/branches/doc/src: libraries/core/input libraries/tools modules/questsystem

rgrieder at orxonox.net rgrieder at orxonox.net
Wed Sep 1 10:59:42 CEST 2010


Author: rgrieder
Date: 2010-09-01 10:59:41 +0200 (Wed, 01 Sep 2010)
New Revision: 7307

Modified:
   code/branches/doc/src/libraries/core/input/InputState.h
   code/branches/doc/src/libraries/tools/Timer.h
   code/branches/doc/src/modules/questsystem/QuestItem.cc
Log:
Fixed three more Doxygen warnings.

Modified: code/branches/doc/src/libraries/core/input/InputState.h
===================================================================
--- code/branches/doc/src/libraries/core/input/InputState.h	2010-08-31 22:46:06 UTC (rev 7306)
+++ code/branches/doc/src/libraries/core/input/InputState.h	2010-09-01 08:59:41 UTC (rev 7307)
@@ -127,7 +127,7 @@
         //! Call this if you have applied the changes resulting from changed handlers
         void resetExpiration() { bExpired_ = false; }
 
-        //! Updates one specific device handler with #device#Updated
+        //! Updates one specific device handler with deviceUpdated
         void update(float dt, unsigned int device);
         //! Updates all handlers with allDevicesUpdated
         void update(float dt);

Modified: code/branches/doc/src/libraries/tools/Timer.h
===================================================================
--- code/branches/doc/src/libraries/tools/Timer.h	2010-08-31 22:46:06 UTC (rev 7306)
+++ code/branches/doc/src/libraries/tools/Timer.h	2010-09-01 08:59:41 UTC (rev 7307)
@@ -32,8 +32,9 @@
 
     The Timer is a callback-object, calling a given function after a given time-interval.
 
-    Usage:
+    Usage: <br>
     header.h:
+    @code
         class ClassName
         {
             public:
@@ -41,8 +42,10 @@
                 void functionName();
                 Timer myTimer;
         };
+    @endcode
 
     source.cc:
+    @code
         #include "core/command/Executor.h"
 
         ClassName::ClassName()
@@ -55,6 +58,7 @@
             whateveryouwant();
             something(else);
         }
+    @endcode
 */
 
 #ifndef _Timer_H__

Modified: code/branches/doc/src/modules/questsystem/QuestItem.cc
===================================================================
--- code/branches/doc/src/modules/questsystem/QuestItem.cc	2010-08-31 22:46:06 UTC (rev 7306)
+++ code/branches/doc/src/modules/questsystem/QuestItem.cc	2010-09-01 08:59:41 UTC (rev 7307)
@@ -76,8 +76,9 @@
 
     /**
     @brief
-        Sets the id of the QuestItem.
-    The id must be of GUID form. See 'http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure' for more information.
+        Sets the id of the QuestItem. The id must be of GUID form.
+    @see
+        http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure
     @param id
         The id to be set.
     */




More information about the Orxonox-commit mailing list