Changeset 7363 for code/branches/doc

Timestamp:

Sep 6, 2010, 2:15:49 AM (14 years ago)

Author:

landauf

Message:

assigned a group to each header file in the core library

Location:

code/branches/doc

Files:

• doc/api/Groups.dox (modified) (1 diff)
• src/libraries/core/BaseObject.h (modified) (1 diff)
• src/libraries/core/ClassFactory.h (modified) (1 diff)
• src/libraries/core/ClassTreeMask.h (modified) (1 diff)
• src/libraries/core/CommandLineParser.h (modified) (1 diff)
• src/libraries/core/ConfigFileManager.h (modified) (1 diff)
• src/libraries/core/ConfigValueContainer.h (modified) (1 diff)
• src/libraries/core/ConfigValueIncludes.h (modified) (1 diff)
• src/libraries/core/Core.h (modified) (1 diff)
• src/libraries/core/CoreIncludes.h (modified) (1 diff)
• src/libraries/core/DynLib.h (modified) (1 diff)
• src/libraries/core/DynLibManager.h (modified) (1 diff)
• src/libraries/core/Event.h (modified) (1 diff)
• src/libraries/core/EventIncludes.h (modified) (1 diff)
• src/libraries/core/GUIManager.h (modified) (1 diff)
• src/libraries/core/Game.h (modified) (1 diff)
• src/libraries/core/GameMode.h (modified) (1 diff)
• src/libraries/core/GameState.h (modified) (1 diff)
• src/libraries/core/GraphicsManager.h (modified) (1 diff)
• src/libraries/core/Identifier.h (modified) (1 diff)
• src/libraries/core/Iterator.h (modified) (1 diff)
• src/libraries/core/Language.h (modified) (1 diff)
• src/libraries/core/Loader.h (modified) (1 diff)
• src/libraries/core/LuaState.h (modified) (1 diff)
• src/libraries/core/MemoryArchive.h (modified) (1 diff)
• src/libraries/core/MetaObjectList.h (modified) (1 diff)
• src/libraries/core/Namespace.h (modified) (1 diff)
• src/libraries/core/NamespaceNode.h (modified) (1 diff)
• src/libraries/core/ObjectList.h (modified) (1 diff)
• src/libraries/core/ObjectListBase.h (modified) (1 diff)
• src/libraries/core/ObjectListIterator.h (modified) (1 diff)
• src/libraries/core/OrxonoxClass.h (modified) (1 diff)
• src/libraries/core/PathConfig.h (modified) (1 diff)
• src/libraries/core/Resource.h (modified) (1 diff)
• src/libraries/core/SmartPtr.h (modified) (1 diff)
• src/libraries/core/SubclassIdentifier.h (modified) (1 diff)
• src/libraries/core/Super.h (modified) (1 diff)
• src/libraries/core/Template.h (modified) (1 diff)
• src/libraries/core/Thread.h (modified) (1 diff)
• src/libraries/core/ThreadPool.h (modified) (1 diff)
• src/libraries/core/ToluaInterface.h (modified) (1 diff)
• src/libraries/core/WeakPtr.h (modified) (1 diff)
• src/libraries/core/WindowEventListener.h (modified) (1 diff)
• src/libraries/core/XMLFile.h (modified) (1 diff)
• src/libraries/core/XMLNameListener.h (modified) (1 diff)
• src/libraries/core/XMLPort.h (modified) (1 diff)

code/branches/doc/doc/api/Groups.dox

@@ -64 +64 @@
 
 /**
-    @defgroup Events Events
+    @defgroup Input Input
     @ingroup Core
 */
 
 /**
-    @defgroup Input Input
+    @defgroup Management Management
     @ingroup Core
 */

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

@@ -28 +28 @@
 
 /**
+    @defgroup BaseObject BaseObject
+    @ingroup Core
+*/
+
+/**
     @file
+    @ingroup BaseObject
     @brief Definition of the BaseObject class.
 

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

@@ -29 +29 @@
 /**
     @file
+    @ingroup Object Factory
     @brief Definition and implementation of the ClassFactory class
 

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

@@ -29 +29 @@
 /**
     @file
+    @ingroup Class
     @brief Definition of the ClassTreeMask, ClassTreeMaskNode and ClassTreeMaskIterator classes.
 

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

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

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @file
+    @ingroup Config ConfigFile
+*/
 
 #ifndef _ConfigFileManager_H__

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

@@ -29 +29 @@
 /**
     @file
+    @ingroup Config ConfigFile
     @brief Definition of the ConfigValueContainer class.
 

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

@@ -28 +28 @@
 
 /**
+    @defgroup ConfigFile Config file
+    @ingroup Config
+*/
+
+/**
 @file
+@ingroup Config ConfigFile
 @brief
     Definition of macros and functions for config-values.

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

@@ -27 +27 @@
  *
  */
+
+/**
+    @defgroup CoreGame Core and Game
+    @ingroup Management
+*/
+
+/**
+    @file
+    @ingroup Management CoreGame
+*/
 
 #ifndef _Core_H__

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

@@ -28 +28 @@
 
 /**
+    @defgroup Factory RegisterObject() and CreateFactory()
+    @ingroup Object
+*/
+
+/**
     @file
+    @ingroup Object Factory
     @brief Definition of macros for Identifiers
 

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

@@ -29 +29 @@
 
 // 08/11/2009: Small adjustments for Orxonox by Fabian 'x3n' Landau
+
+/**
+    @file
+    @ingroup Management CoreGame
+*/
 
 #ifndef _Core_DynLib_H__

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

@@ -29 +29 @@
 
 // 08/11/2009: Small adjustments for Orxonox by Fabian 'x3n' Landau
+
+/**
+    @file
+    @ingroup Management CoreGame
+*/
 
 #ifndef _Core_DynLibManager_H__

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @defgroup Event Events
+    @ingroup Core
+*/
+
+/**
+    @file
+    @ingroup Event
+*/
 
 #ifndef _Event_H__

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @file
+    @ingroup Event
+*/
 
 #ifndef _EventIncludes_H__

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

@@ -27 +27 @@
  *
  */
+
+/**
+    @file
+    @ingroup Graphics
+*/
 
 #ifndef _GUIManager_H__

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

@@ -29 +29 @@
 /**
 @file
+@ingroup Management CoreGame
 @brief
     Declaration of Game Singleton.

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

@@ -29 +29 @@
 /**
     @file
+    @ingroup Management CoreGame
     @brief Declaration of the GameMode class.
 */

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

@@ -29 +29 @@
 /**
 @file
+@ingroup Management CoreGame
 @brief
     Definition of GameState class.

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

@@ -29 +29 @@
 
 /**
+    @defgroup Graphics Graphics and GUI
+    @ingroup Core
+*/
+
+/**
 @file
+@ingroup Graphics
 @brief
     Declaration of GraphicsManager Singleton.

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

@@ -28 +28 @@
 
 /**
+    @defgroup Identifier Identifier
+    @ingroup Class
+*/
+
+/**
     @file
+    @ingroup Class Identifier
     @brief Definition of the Identifier class, definition and implementation of the ClassIdentifier class.
 

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

@@ -29 +29 @@
 /**
     @file
+    @ingroup Object ObjectList
     @brief Definition and implementation of the Iterator class.
 

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

@@ -28 +28 @@
 
 /**
+    @defgroup Language Language
+    @ingroup Core
+*/
+
+/**
     @file
+    @ingroup Language
     @brief Definition of the Language and the LanguageEntry class.
 

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @defgroup Loader Loader
+    @ingroup XML
+*/
+
+/**
+    @file
+    @ingroup XML Loader
+*/
 
 #ifndef _Loader_H__

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

@@ -27 +27 @@
  *
  */
+
+/**
+    @defgroup Lua Lua
+    @ingroup Core
+*/
+
+/**
+    @file
+    @ingroup Lua
+*/
 
 #ifndef _LuaState_H__

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @file
+    @ingroup Management Resources
+*/
 
 #ifndef _MemoryArchive_H__

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

@@ -29 +29 @@
 /**
     @file
+    @ingroup Object ObjectList
     @brief Definition of the MetaObjectList class.
 

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @file
+    @ingroup XML Loader
+*/
 
 #ifndef _Namespace_H__

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @file
+    @ingroup XML Loader
+*/
 
 #ifndef _NamespaceNode_H__

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

@@ -28 +28 @@
 
 /**
+    @defgroup ObjectList Object-lists and iterators
+    @ingroup Object
+*/
+
+/**
     @file
+    @ingroup Object ObjectList
     @brief Definition and implementation of the ObjectList class.
 

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

@@ -29 +29 @@
 /**
     @file
+    @ingroup Object ObjectList
     @brief Definition of the ObjectListBase class.
 

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

@@ -29 +29 @@
 /**
     @file
+    @ingroup Object ObjectList
     @brief Definition and implementation of the Iterator class.
 

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

@@ -28 +28 @@
 
 /**
+    @defgroup OrxonoxClass OrxonoxClass
+    @ingroup Class
+*/
+
+/**
     @file
+    @ingroup Class OrxonoxClass
     @brief Declaration of the OrxonoxClass Class.
 

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @file
+    @ingroup Management Resources
+*/
 
 #ifndef _PathConfig_H__

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @defgroup Resources Resources
+    @ingroup Management
+*/
+
+/**
+    @file
+    @ingroup Management Resources
+*/
 
 #ifndef _Core_Resource_H__

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

@@ -28 +28 @@
 
 // Inspired by boost::intrusive_ptr by Peter Dimov
+
+/**
+    @defgroup SmartPtr SmartPtr<T> and WeakPtr<T>
+    @ingroup Object
+*/
+
+/**
+    @file
+    @ingroup Object SmartPtr
+*/
 
 #ifndef _SmartPtr_H__

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

@@ -29 +29 @@
 /**
     @file
+    @ingroup Class Identifier
     @brief Definition of SubclassIdentifier.
 

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

@@ -28 +28 @@
 
 /**
+    @defgroup Super Super
+    @ingroup Class
+*/
+
+/**
     @file
+    @ingroup Class Super
     @brief Definition of all super-function related macros.
 

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @defgroup Template Template
+    @ingroup XML
+*/
+
+/**
+    @file
+    @ingroup XML Template
+*/
 
 #ifndef _Template_H__

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @file
+    @ingroup ThreadPool
+*/
 
 #ifndef _Thread_H__

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @defgroup ThreadPool Thread pool
+    @ingroup Core
+*/
+
+/**
+    @file
+    @ingroup ThreadPool
+*/
 
 #ifndef _ThreadPool_H__

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

@@ -29 +29 @@
 /**
 @file
+@ingroup Lua
+@brief
     This is required because tolua would parse this macro in LuaState.h and fail
 */

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

@@ -28 +28 @@
 
 // Inspired by boost::intrusive_ptr by Peter Dimov
+
+/**
+    @file
+    @ingroup Object SmartPtr
+*/
 
 #ifndef _WeakPtr_H__

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @file
+    @ingroup Graphics
+*/
 
 #ifndef _WindowEventListener_H__

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

@@ -26 +26 @@
  *
  */
+
+/**
+    @file
+    @ingroup XML XMLPort
+*/
 
 #ifndef _XMLFile_H__

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

@@ -27 +27 @@
  */
 
+/**
+    @file
+    @ingroup XML XMLPort
+*/
+
 #ifndef _XMLNameListener_H__
 #define _XMLNameListener_H__

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

@@ -28 +28 @@
 
 /**
+    @defgroup XMLPort XMLPort
+    @ingroup XML
+*/
+
+/**
     @file
+    @ingroup XML XMLPort
     @brief Declaration of the XMLPort helper classes and macros.