Changeset 7375 for code/branches/doc/src/libraries/core

Timestamp:

Sep 8, 2010, 1:39:02 AM (14 years ago)

Author:

landauf

Message:

added documentation

Location:

code/branches/doc/src/libraries/core

Files:

• BaseObject.h (modified) (1 diff)
• ClassFactory.h (modified) (1 diff)
• ConfigFileManager.h (modified) (1 diff)
• ConfigValueContainer.h (modified) (1 diff)
• Core.h (modified) (1 diff)
• CoreIncludes.h (modified) (1 diff)
• DynLib.h (modified) (3 diffs)
• DynLibManager.h (modified) (1 diff)
• Game.h (modified) (1 diff)
• GameMode.h (modified) (1 diff)
• Identifier.h (modified) (1 diff)
• Iterator.h (modified) (1 diff)
• ObjectList.h (modified) (1 diff)
• ObjectListBase.h (modified) (1 diff)
• ObjectListIterator.h (modified) (1 diff)
• OrxonoxClass.cc (modified) (1 diff)
• OrxonoxClass.h (modified) (1 diff)
• SmartPtr.h (modified) (1 diff)
• Super.h (modified) (1 diff)
• WeakPtr.h (modified) (1 diff)

code/branches/doc/src/libraries/core/BaseObject.h

@@ -35 +35 @@
     @file
     @ingroup BaseObject
-    @brief Definition of the BaseObject class.
+    @brief Declaration of BaseObject, the base class of all objects in Orxonox.
 
     The BaseObject is the parent of all classes representing an instance in the game.

code/branches/doc/src/libraries/core/ClassFactory.h

@@ -32 +32 @@
     @brief Definition and implementation of the ClassFactory class
 
-    The ClassFactory is able to create new objects of a specific class.
+    The ClassFactory is able to create new objects of a specific class which creates objects.
 */
 

code/branches/doc/src/libraries/core/ConfigFileManager.h

@@ -30 +30 @@
     @file
     @ingroup Config ConfigFile
-    @brief Declaration of ConfigFileManager and its helper classes.
+    @brief Declaration of ConfigFileManager and its helper classes, used to load and save config files.
 */
 

code/branches/doc/src/libraries/core/ConfigValueContainer.h

@@ -30 +30 @@
     @file
     @ingroup Config ConfigFile
-    @brief Declaration of the ConfigValueContainer class.
+    @brief Declaration of the ConfigValueContainer class, caches a config-value.
 
     The ConfigValueContainer class contains all needed information about a configurable variable:

code/branches/doc/src/libraries/core/Core.h

@@ -36 +36 @@
     @file
     @ingroup Management CoreGame
+    @brief Declaration of the Core singleton which is used to configure the program basics.
 */
 

code/branches/doc/src/libraries/core/CoreIncludes.h

@@ -35 +35 @@
     @file
     @ingroup Object Factory
-    @brief Definition of macros for Identifiers
+    @brief Defines several very important macros used to register objects, create factories, and to work with identifiers.
 
     Every class needs the @c RegisterObject(class) macro in its constructor. If the class is an interface

code/branches/doc/src/libraries/core/DynLib.h

@@ -33 +33 @@
     @file
     @ingroup Management CoreGame
+    @brief Declaration of DynLib which represents a dynamically loaded module.
 */
 
@@ -66 +67 @@
 namespace orxonox
 {
-    /** Resource holding data about a dynamic library.
+    /** %Resource holding data about a dynamic library.
         @remarks
             This class holds the data required to get symbols from
@@ -74 +75 @@
         @since
             27 January 2002
-        @see
-            Resource
     */
     class _CoreExport DynLib

code/branches/doc/src/libraries/core/DynLibManager.h

@@ -33 +33 @@
     @file
     @ingroup Management CoreGame
+    @brief Declaration of DynLibManager, used to load modules at runtime.
 */
 

code/branches/doc/src/libraries/core/Game.h

@@ -31 +31 @@
 @ingroup Management CoreGame
 @brief
-    Declaration of Game Singleton.
+    Declaration of Game Singleton which is responsible for running the game.
  */
 

code/branches/doc/src/libraries/core/GameMode.h

@@ -30 +30 @@
     @file
     @ingroup Management CoreGame
-    @brief Declaration of the GameMode class.
+    @brief Declaration of the GameMode class which stores and returns the current mode of the game.
 */
 

code/branches/doc/src/libraries/core/Identifier.h

@@ -35 +35 @@
     @file
     @ingroup Class Identifier
-    @brief Declaration of Identifier, definition of ClassIdentifier<T>.
+    @brief Declaration of Identifier, definition of ClassIdentifier<T>; used to identify the class of an object.
 
     @anchor IdentifierExample

code/branches/doc/src/libraries/core/Iterator.h

@@ -30 +30 @@
     @file
     @ingroup Object ObjectList
-    @brief Definition of the Iterator class.
+    @brief Definition of the Iterator class, used to iterate through object-lists.
 
     @anchor IteratorExample

code/branches/doc/src/libraries/core/ObjectList.h

@@ -35 +35 @@
     @file
     @ingroup Object ObjectList
-    @brief Definition of the ObjectList class.
+    @brief Definition of the ObjectList class, a wrapper of ObjectListBase.
 
     @ref orxonox::ObjectList "ObjectList<T>" is a wrapper of an @ref orxonox::ObjectListBase

code/branches/doc/src/libraries/core/ObjectListBase.h

@@ -30 +30 @@
     @file
     @ingroup Object ObjectList
-    @brief Declaration of the ObjectListBase class.
+    @brief Declaration of the ObjectListBase class which stores all objects of each class.
 
     orxonox::ObjectListBase is a double-linked list, used by @ref orxonox::Identifier "Identifiers"

code/branches/doc/src/libraries/core/ObjectListIterator.h

@@ -30 +30 @@
     @file
     @ingroup Object ObjectList
-    @brief Definition of the ObjectListIterator class.
+    @brief Definition of the ObjectListIterator class, used to iterate through object-lists.
 
     @anchor ObjectListIteratorExample

code/branches/doc/src/libraries/core/OrxonoxClass.cc

@@ -29 +29 @@
 /**
     @file
-    @brief Implementation of the OrxonoxClass Class.
+    @brief Implementation of OrxonoxClass.
 */
 

code/branches/doc/src/libraries/core/OrxonoxClass.h

@@ -35 +35 @@
     @file
     @ingroup Class OrxonoxClass
-    @brief Declaration of the OrxonoxClass Class.
+    @brief Declaration of OrxonoxClass, the base class of all objects and interfaces in Orxonox.
 
     All objects and interfaces of the game-logic (not the engine) are derived from OrxonoxClass.

code/branches/doc/src/libraries/core/SmartPtr.h

@@ -37 +37 @@
     @file
     @ingroup Object SmartPtr
-    @brief Definition of SmartPtr<T>.
+    @brief Definition of SmartPtr<T>, wraps a pointer to an object and keeps it alive.
 
     @anchor SmartPtrExample

code/branches/doc/src/libraries/core/Super.h

@@ -35 +35 @@
     @file
     @ingroup Class Super
-    @brief Definition of all super-function related macros.
+    @brief Definition of all super-function related macros, used to call functions of the base class.
 
     This file defines all macros needed to add a new "super-function". If you add

code/branches/doc/src/libraries/core/WeakPtr.h

@@ -32 +32 @@
     @file
     @ingroup Object SmartPtr
-    @brief Definition of WeakPtr<T>.
+    @brief Definition of WeakPtr<T>, wraps a pointer to an object.
 
     @anchor WeakPtrExample