Changeset 7645 for code/branches/releasetodo/src

Timestamp:

Nov 13, 2010, 9:10:57 PM (14 years ago)

Author:

dafrick

Message:

Small adjustments.

Location:

code/branches/releasetodo/src

Files:

• libraries/core/GUIManager.cc (modified) (4 diffs)
• orxonox/LevelInfo.cc (modified) (2 diffs)
• orxonox/LevelInfo.h (modified) (3 diffs)

code/branches/releasetodo/src/libraries/core/GUIManager.cc

@@ -438 +438 @@
     }
 
+    /**
+    @brief
+        Subscribe the input function to the input event for the input window.
+        This is a helper to be used in lua, because subscribeScriptedEvent() doesn't work in lua.
+    @param window
+        The window for which the event is subscribed.
+    @param event
+        The type of event to which we subscribe.
+    @param function
+        The function that is called when the event occurs.
+    */
     void GUIManager::subscribeEventHelper(CEGUI::Window* window, const std::string& event, const std::string& function)
     {
@@ -443 +454 @@
     }
 
+    /**
+    @brief
+        Set the input tooltip text for the input ListboxItem.
+    @param item
+        The ListboxItem for which the tooltip should be set.
+    @param tooltip
+        The tooltip text that should be set.
+    */
     void GUIManager::setTooltipTextHelper(CEGUI::ListboxItem* item, const std::string& tooltip)
     {
@@ -448 +467 @@
     }
 
+    /**
+    @brief
+        Set whether the tooltips for the input Listbox are enabled.
+    @param listbox
+        The Listbox for which to enable (or disable) tooltips.
+    @param enabled
+        Whether to enable or disabel the tooltips.
+    */
     void GUIManager::setItemTooltipsEnabledHelper(CEGUI::Listbox* listbox, bool enabled)
     {
@@ -453 +480 @@
     }
 
-    
 }

code/branches/releasetodo/src/orxonox/LevelInfo.cc

@@ -77 +77 @@
 
     }
-    
-    void LevelInfoItem::initializeTags(void)
+
+    /**
+    @brief
+        Initialize the set of allowed tags.
+    */
+    /*static*/ void LevelInfoItem::initializeTags(void)
     {
         if(!LevelInfoItem::initialized_s)
@@ -87 +91 @@
             LevelInfoItem::possibleTags_s.insert("showcase");
             LevelInfoItem::possibleTags_s.insert("tutorial");
+            LevelInfoItem::possibleTags_s.insert("presentation");
         }
     }

code/branches/releasetodo/src/orxonox/LevelInfo.h

@@ -38 +38 @@
 #include "OrxonoxPrereqs.h"
 
-#include <map>
 #include <set>
 #include <string>
@@ -121 +120 @@
         private:
             void tagsUpdated(void); //!< Updates the comma-seperated string of all tags, if the set of tags has changed.
-            
-            static std::set<std::string> possibleTags_s;
-            static const bool initialized_s = false;
-            void initializeTags(void);
-            bool validateTag(const std::string& tag)
-                { this->initializeTags(); return LevelInfoItem::possibleTags_s.find(tag) != LevelInfoItem::possibleTags_s.end(); }
+
+            static void initializeTags(void); //!< Initialize the set of allowed tags.
+            /**
+            @brief Check whether an input tag is allowed.
+            @param tag The tag to check.
+            @return Returns true if the input tag is allowed, false if not.
+            */
+            static bool validateTag(const std::string& tag)
+                { LevelInfoItem::initializeTags(); return LevelInfoItem::possibleTags_s.find(tag) != LevelInfoItem::possibleTags_s.end(); }
+
+            static std::set<std::string> possibleTags_s; //!< The set of allowed tags.
+            static const bool initialized_s = false; //!< Whether the set of allowed tags has been inizialized.
 
             std::string name_; //!< The name of the Level.
@@ -140 +145 @@
         - @b name The name of the level.
         - @b description The description of the level.
-        - @b tags A comma-seperated string of tags.
+        - @b tags A comma-seperated string of tags. Allowed tags are: <em>test</em>, <em>singleplayer</em>, <em>multiplayer</em>, <em>showcase</em>, <em>tutorial</em>, <em>presentation</em>.
 
         An example would be: