Changeset 11099 for code/trunk/src/libraries/core/CoreIncludes.h

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/CoreIncludes.h (modified) (2 diffs)

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();