Changeset 11099 for code/trunk/src/libraries/core/GUIManager.cc

Timestamp:

Jan 27, 2016, 6:50:51 PM (8 years ago)

Author:

muemart

Message:

Fix loads of doxygen warnings and other documentation issues

File:

• code/trunk/src/libraries/core/GUIManager.cc (modified) (2 diffs)

code/trunk/src/libraries/core/GUIManager.cc

@@ -793 +793 @@
     }
 
-    /** Executes a CEGUI function normally, but catches CEGUI::ScriptException.
+    /**
+    @copydoc protectedCeguiSystemCall
+    @param function
+        Any callable object/function that takes one parameter.
+    @param object
+        Object to be used as an argument for the @p function
+    @return
+        True if input was handled, false otherwise. A caught exception yields true.
+    */
+    template <typename FunctionType, typename ObjectType>
+    bool GUIManager::protectedCall(FunctionType function, ObjectType object)
+    {
+        try
+        {
+            return function(object);
+        }
+        catch (CEGUI::ScriptException& ex)
+        {
+            // Display the error and proceed. See @remarks why this can be dangerous.
+            orxout(internal_error) << ex.getMessage() << endl;
+            return true;
+        }
+    }
+
+    /**
+        Executes a CEGUI function normally, but catches CEGUI::ScriptException.
         When a ScriptException occurs, the error message will be displayed and
         the program carries on.
@@ -808 +833 @@
         True if input was handled, false otherwise. A caught exception yields true.
     */
-    template <typename FunctionType, typename ObjectType>
-    bool GUIManager::protectedCall(FunctionType function, ObjectType object)
-    {
-        try
-        {
-            return function(object);
-        }
-        catch (CEGUI::ScriptException& ex)
-        {
-            // Display the error and proceed. See @remarks why this can be dangerous.
-            orxout(internal_error) << ex.getMessage() << endl;
-            return true;
-        }
-    }
-
     template <typename FunctionType>
     bool GUIManager::protectedCeguiSystemCall(FunctionType function)