Changeset 11099 for code/trunk/src/libraries/core

Timestamp:

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

Author:

muemart

Message:

Fix loads of doxygen warnings and other documentation issues

Location:

code/trunk/src/libraries/core

Files:

• CoreIncludes.h (modified) (2 diffs)
• GUIManager.cc (modified) (2 diffs)
• class/IdentifierManager.cc (modified) (1 diff)
• command/CommandExecutor.cc (modified) (1 diff)
• command/ConsoleCommandCompilation.cc (modified) (2 diffs)
• commandline/CommandLineIncludes.h (modified) (1 diff)
• commandline/CommandLineParser.cc (modified) (2 diffs)
• commandline/CommandLineParser.h (modified) (1 diff)
• config/ConfigValueContainer.h (modified) (2 diffs)
• object/IteratorBase.h (modified) (1 diff)
• object/ObjectListBase.h (modified) (1 diff)

code/trunk/src/libraries/core/CoreIncludes.h

@@ -125 +125 @@
     @brief Registers the class in the framework with a given Factory.
     @param ClassName The name of the class
+    @param FactoryInstance An instance of a factory that can create the class
+    @param bLoadable Whether the class is allowed to be loaded through XML
 */
 #define RegisterClassWithFactory(ClassName, FactoryInstance, bLoadable) \
@@ -201 +203 @@
         @note This of course only works with Identifiables.
               The only use is in conjunction with macros that don't know the class type.
-        @param object Pointer to an Identifiable
+        @param p Pointer to an Identifiable
     */
     template <class T>
-    inline Identifier* ClassByObjectType(const T*)
+    inline Identifier* ClassByObjectType(const T* p)
     {
         return ClassIdentifier<T>::getIdentifier();

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)

code/trunk/src/libraries/core/class/IdentifierManager.cc

@@ -255 +255 @@
     /**
         @brief Returns the Identifier with a given typeid-name.
-        @param name The typeid-name of the wanted Identifier
+        @param typeInfo The type_info of the wanted Identifier
         @return The Identifier
     */

code/trunk/src/libraries/core/command/CommandExecutor.cc

@@ -67 +67 @@
         @param command A string containing the command
         @param useTcl If true, the command is passed to tcl (see TclBind)
+        @param printErrors If true, print an error when command failed
         @return Returns the error-code (see @ref CommandExecutorErrorCodes "error codes")
     */

code/trunk/src/libraries/core/command/ConsoleCommandCompilation.cc

@@ -100 +100 @@
         @brief Prints text to the console.
         @param level_name The name of the output level
+        @param text The text to print
     */
     void orxout_level(const std::string& level_name, const std::string& text)
@@ -119 +120 @@
         @param level_name The name of the output level
         @param context_name The name of the output context
+        @param text The text to print
     */
     void orxout_level_context(const std::string& level_name, const std::string& context_name, const std::string& text)

code/trunk/src/libraries/core/commandline/CommandLineIncludes.h

@@ -30 +30 @@
     @defgroup CmdArgs Commandline arguments
     @ingroup Config
-    @brief For a reference of all commandline arguments see @ref cmdargspage
 */
 

code/trunk/src/libraries/core/commandline/CommandLineParser.cc

@@ -218 +218 @@
     @param value
         String containing the value
-    @param bParsingFile
-        Parsing a file or the command line itself
     */
     void CommandLineParser::checkFullArgument(const std::string& name, const std::string& value)
@@ -237 +235 @@
     @param value
         String containing the value
-    @param bParsingFile
-        Parsing a file or the command line itself
     */
     void CommandLineParser::checkShortcut(const std::string& shortcut, const std::string& value)

code/trunk/src/libraries/core/commandline/CommandLineParser.h

@@ -26 +26 @@
  *
  */
-
-/**
-    @defgroup CmdArgs Commandline arguments
-    @ingroup Config
-    @brief For a reference of all commandline arguments see @ref cmdargspage
-*/
 
 /**

code/trunk/src/libraries/core/config/ConfigValueContainer.h

@@ -109 +109 @@
             */
             template <class D, class V>
-            ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const D& defvalue, const V&)
+            ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const D& defvalue, const V& value)
             {
                 this->init(type, identifier, sectionname, varname);
@@ -125 +125 @@
             */
             template <class D, class V>
-            ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const std::vector<D>& defvalue, const std::vector<V>&)
+            ConfigValueContainer(ConfigFileType::Value type, Identifier* identifier, const std::string& sectionname, const std::string& varname, const std::vector<D>& defvalue, const std::vector<V>& value)
             {
                 this->init(type, identifier, sectionname, varname);

code/trunk/src/libraries/core/object/IteratorBase.h

@@ -173 +173 @@
             /**
                 @brief Increments the Iterator if it points at the given element.
-                @param object The object to compare with
+                @param element The element to compare with
             */
             virtual void removedElement(ObjectListBaseElement* element) override

code/trunk/src/libraries/core/object/ObjectListBase.h

@@ -55 +55 @@
             /**
                 @brief Constructor: Creates the list-element with an object.
-                @param objectBase The object to store
+                @param object The object to store
             */
             ObjectListBaseElement(Listable* object) : next_(nullptr), prev_(nullptr), objectBase_(object), list_(nullptr) {}