[Orxonox-commit 2658] r7363 - in code/branches/doc: doc/api src/libraries/core
landauf at orxonox.net
landauf at orxonox.net
Mon Sep 6 02:15:49 CEST 2010
Author: landauf
Date: 2010-09-06 02:15:49 +0200 (Mon, 06 Sep 2010)
New Revision: 7363
Modified:
code/branches/doc/doc/api/Groups.dox
code/branches/doc/src/libraries/core/BaseObject.h
code/branches/doc/src/libraries/core/ClassFactory.h
code/branches/doc/src/libraries/core/ClassTreeMask.h
code/branches/doc/src/libraries/core/CommandLineParser.h
code/branches/doc/src/libraries/core/ConfigFileManager.h
code/branches/doc/src/libraries/core/ConfigValueContainer.h
code/branches/doc/src/libraries/core/ConfigValueIncludes.h
code/branches/doc/src/libraries/core/Core.h
code/branches/doc/src/libraries/core/CoreIncludes.h
code/branches/doc/src/libraries/core/DynLib.h
code/branches/doc/src/libraries/core/DynLibManager.h
code/branches/doc/src/libraries/core/Event.h
code/branches/doc/src/libraries/core/EventIncludes.h
code/branches/doc/src/libraries/core/GUIManager.h
code/branches/doc/src/libraries/core/Game.h
code/branches/doc/src/libraries/core/GameMode.h
code/branches/doc/src/libraries/core/GameState.h
code/branches/doc/src/libraries/core/GraphicsManager.h
code/branches/doc/src/libraries/core/Identifier.h
code/branches/doc/src/libraries/core/Iterator.h
code/branches/doc/src/libraries/core/Language.h
code/branches/doc/src/libraries/core/Loader.h
code/branches/doc/src/libraries/core/LuaState.h
code/branches/doc/src/libraries/core/MemoryArchive.h
code/branches/doc/src/libraries/core/MetaObjectList.h
code/branches/doc/src/libraries/core/Namespace.h
code/branches/doc/src/libraries/core/NamespaceNode.h
code/branches/doc/src/libraries/core/ObjectList.h
code/branches/doc/src/libraries/core/ObjectListBase.h
code/branches/doc/src/libraries/core/ObjectListIterator.h
code/branches/doc/src/libraries/core/OrxonoxClass.h
code/branches/doc/src/libraries/core/PathConfig.h
code/branches/doc/src/libraries/core/Resource.h
code/branches/doc/src/libraries/core/SmartPtr.h
code/branches/doc/src/libraries/core/SubclassIdentifier.h
code/branches/doc/src/libraries/core/Super.h
code/branches/doc/src/libraries/core/Template.h
code/branches/doc/src/libraries/core/Thread.h
code/branches/doc/src/libraries/core/ThreadPool.h
code/branches/doc/src/libraries/core/ToluaInterface.h
code/branches/doc/src/libraries/core/WeakPtr.h
code/branches/doc/src/libraries/core/WindowEventListener.h
code/branches/doc/src/libraries/core/XMLFile.h
code/branches/doc/src/libraries/core/XMLNameListener.h
code/branches/doc/src/libraries/core/XMLPort.h
Log:
assigned a group to each header file in the core library
Modified: code/branches/doc/doc/api/Groups.dox
===================================================================
--- code/branches/doc/doc/api/Groups.dox 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/doc/api/Groups.dox 2010-09-06 00:15:49 UTC (rev 7363)
@@ -63,12 +63,12 @@
*/
/**
- @defgroup Events Events
+ @defgroup Input Input
@ingroup Core
*/
/**
- @defgroup Input Input
+ @defgroup Management Management
@ingroup Core
*/
Modified: code/branches/doc/src/libraries/core/BaseObject.h
===================================================================
--- code/branches/doc/src/libraries/core/BaseObject.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/BaseObject.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,13 @@
*/
/**
+ @defgroup BaseObject BaseObject
+ @ingroup Core
+*/
+
+/**
@file
+ @ingroup BaseObject
@brief Definition of the BaseObject class.
The BaseObject is the parent of all classes representing an instance in the game.
Modified: code/branches/doc/src/libraries/core/ClassFactory.h
===================================================================
--- code/branches/doc/src/libraries/core/ClassFactory.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ClassFactory.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ @ingroup Object Factory
@brief Definition and implementation of the ClassFactory class
The ClassFactory is able to create new objects of a specific class.
Modified: code/branches/doc/src/libraries/core/ClassTreeMask.h
===================================================================
--- code/branches/doc/src/libraries/core/ClassTreeMask.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ClassTreeMask.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ @ingroup Class
@brief Definition of the ClassTreeMask, ClassTreeMaskNode and ClassTreeMaskIterator classes.
ClassTreeMask is a class to define a mask of the class-tree beginning with BaseObject.
Modified: code/branches/doc/src/libraries/core/CommandLineParser.h
===================================================================
--- code/branches/doc/src/libraries/core/CommandLineParser.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/CommandLineParser.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,7 @@
*/
/**
- @defgroup CmdArgs Commandline Arguments
+ @defgroup CmdArgs Commandline arguments
@ingroup Config
@brief For a reference of all commandline arguments see @ref cmdargspage
*/
Modified: code/branches/doc/src/libraries/core/ConfigFileManager.h
===================================================================
--- code/branches/doc/src/libraries/core/ConfigFileManager.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ConfigFileManager.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup Config ConfigFile
+*/
+
#ifndef _ConfigFileManager_H__
#define _ConfigFileManager_H__
Modified: code/branches/doc/src/libraries/core/ConfigValueContainer.h
===================================================================
--- code/branches/doc/src/libraries/core/ConfigValueContainer.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ConfigValueContainer.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ @ingroup Config ConfigFile
@brief Definition of the ConfigValueContainer class.
The ConfigValueContainer class contains all needed information about a configurable variable:
Modified: code/branches/doc/src/libraries/core/ConfigValueIncludes.h
===================================================================
--- code/branches/doc/src/libraries/core/ConfigValueIncludes.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ConfigValueIncludes.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,13 @@
*/
/**
+ @defgroup ConfigFile Config file
+ @ingroup Config
+*/
+
+/**
@file
+ at ingroup Config ConfigFile
@brief
Definition of macros and functions for config-values.
*/
Modified: code/branches/doc/src/libraries/core/Core.h
===================================================================
--- code/branches/doc/src/libraries/core/Core.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Core.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,6 +27,16 @@
*
*/
+/**
+ @defgroup CoreGame Core and Game
+ @ingroup Management
+*/
+
+/**
+ @file
+ @ingroup Management CoreGame
+*/
+
#ifndef _Core_H__
#define _Core_H__
Modified: code/branches/doc/src/libraries/core/CoreIncludes.h
===================================================================
--- code/branches/doc/src/libraries/core/CoreIncludes.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/CoreIncludes.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,13 @@
*/
/**
+ @defgroup Factory RegisterObject() and CreateFactory()
+ @ingroup Object
+*/
+
+/**
@file
+ @ingroup Object Factory
@brief Definition of macros for Identifiers
Every class needs the RegisterObject(class) macro in its constructor. If the class is an interface
Modified: code/branches/doc/src/libraries/core/DynLib.h
===================================================================
--- code/branches/doc/src/libraries/core/DynLib.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/DynLib.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -29,6 +29,11 @@
// 08/11/2009: Small adjustments for Orxonox by Fabian 'x3n' Landau
+/**
+ @file
+ @ingroup Management CoreGame
+*/
+
#ifndef _Core_DynLib_H__
#define _Core_DynLib_H__
Modified: code/branches/doc/src/libraries/core/DynLibManager.h
===================================================================
--- code/branches/doc/src/libraries/core/DynLibManager.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/DynLibManager.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -29,6 +29,11 @@
// 08/11/2009: Small adjustments for Orxonox by Fabian 'x3n' Landau
+/**
+ @file
+ @ingroup Management CoreGame
+*/
+
#ifndef _Core_DynLibManager_H__
#define _Core_DynLibManager_H__
Modified: code/branches/doc/src/libraries/core/Event.h
===================================================================
--- code/branches/doc/src/libraries/core/Event.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Event.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,16 @@
*
*/
+/**
+ @defgroup Event Events
+ @ingroup Core
+*/
+
+/**
+ @file
+ @ingroup Event
+*/
+
#ifndef _Event_H__
#define _Event_H__
Modified: code/branches/doc/src/libraries/core/EventIncludes.h
===================================================================
--- code/branches/doc/src/libraries/core/EventIncludes.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/EventIncludes.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup Event
+*/
+
#ifndef _EventIncludes_H__
#define _EventIncludes_H__
Modified: code/branches/doc/src/libraries/core/GUIManager.h
===================================================================
--- code/branches/doc/src/libraries/core/GUIManager.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/GUIManager.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,6 +27,11 @@
*
*/
+/**
+ @file
+ @ingroup Graphics
+*/
+
#ifndef _GUIManager_H__
#define _GUIManager_H__
Modified: code/branches/doc/src/libraries/core/Game.h
===================================================================
--- code/branches/doc/src/libraries/core/Game.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Game.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ at ingroup Management CoreGame
@brief
Declaration of Game Singleton.
*/
Modified: code/branches/doc/src/libraries/core/GameMode.h
===================================================================
--- code/branches/doc/src/libraries/core/GameMode.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/GameMode.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ @ingroup Management CoreGame
@brief Declaration of the GameMode class.
*/
Modified: code/branches/doc/src/libraries/core/GameState.h
===================================================================
--- code/branches/doc/src/libraries/core/GameState.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/GameState.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ at ingroup Management CoreGame
@brief
Definition of GameState class.
*/
Modified: code/branches/doc/src/libraries/core/GraphicsManager.h
===================================================================
--- code/branches/doc/src/libraries/core/GraphicsManager.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/GraphicsManager.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,7 +28,13 @@
*/
/**
+ @defgroup Graphics Graphics and GUI
+ @ingroup Core
+*/
+
+/**
@file
+ at ingroup Graphics
@brief
Declaration of GraphicsManager Singleton.
*/
Modified: code/branches/doc/src/libraries/core/Identifier.h
===================================================================
--- code/branches/doc/src/libraries/core/Identifier.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Identifier.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,13 @@
*/
/**
+ @defgroup Identifier Identifier
+ @ingroup Class
+*/
+
+/**
@file
+ @ingroup Class Identifier
@brief Definition of the Identifier class, definition and implementation of the ClassIdentifier class.
The Identifier contains all needed information about the class it belongs to:
Modified: code/branches/doc/src/libraries/core/Iterator.h
===================================================================
--- code/branches/doc/src/libraries/core/Iterator.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Iterator.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ @ingroup Object ObjectList
@brief Definition and implementation of the Iterator class.
The Iterator of a given class allows to iterate through an ObjectList. Objects in
Modified: code/branches/doc/src/libraries/core/Language.h
===================================================================
--- code/branches/doc/src/libraries/core/Language.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Language.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,13 @@
*/
/**
+ @defgroup Language Language
+ @ingroup Core
+*/
+
+/**
@file
+ @ingroup Language
@brief Definition of the Language and the LanguageEntry class.
The Language class is used, to get a localisation of a string in the configured language.
Modified: code/branches/doc/src/libraries/core/Loader.h
===================================================================
--- code/branches/doc/src/libraries/core/Loader.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Loader.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,16 @@
*
*/
+/**
+ @defgroup Loader Loader
+ @ingroup XML
+*/
+
+/**
+ @file
+ @ingroup XML Loader
+*/
+
#ifndef _Loader_H__
#define _Loader_H__
Modified: code/branches/doc/src/libraries/core/LuaState.h
===================================================================
--- code/branches/doc/src/libraries/core/LuaState.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/LuaState.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,6 +27,16 @@
*
*/
+/**
+ @defgroup Lua Lua
+ @ingroup Core
+*/
+
+/**
+ @file
+ @ingroup Lua
+*/
+
#ifndef _LuaState_H__
#define _LuaState_H__
Modified: code/branches/doc/src/libraries/core/MemoryArchive.h
===================================================================
--- code/branches/doc/src/libraries/core/MemoryArchive.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/MemoryArchive.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup Management Resources
+*/
+
#ifndef _MemoryArchive_H__
#define _MemoryArchive_H__
Modified: code/branches/doc/src/libraries/core/MetaObjectList.h
===================================================================
--- code/branches/doc/src/libraries/core/MetaObjectList.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/MetaObjectList.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ @ingroup Object ObjectList
@brief Definition of the MetaObjectList class.
The MetaObjectList is a single-linked list, containing all list-elements and their
Modified: code/branches/doc/src/libraries/core/Namespace.h
===================================================================
--- code/branches/doc/src/libraries/core/Namespace.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Namespace.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup XML Loader
+*/
+
#ifndef _Namespace_H__
#define _Namespace_H__
Modified: code/branches/doc/src/libraries/core/NamespaceNode.h
===================================================================
--- code/branches/doc/src/libraries/core/NamespaceNode.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/NamespaceNode.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup XML Loader
+*/
+
#ifndef _NamespaceNode_H__
#define _NamespaceNode_H__
Modified: code/branches/doc/src/libraries/core/ObjectList.h
===================================================================
--- code/branches/doc/src/libraries/core/ObjectList.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ObjectList.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,13 @@
*/
/**
+ @defgroup ObjectList Object-lists and iterators
+ @ingroup Object
+*/
+
+/**
@file
+ @ingroup Object ObjectList
@brief Definition and implementation of the ObjectList class.
The ObjectList is a wrapper of an ObjectListBase of a given class.
Modified: code/branches/doc/src/libraries/core/ObjectListBase.h
===================================================================
--- code/branches/doc/src/libraries/core/ObjectListBase.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ObjectListBase.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ @ingroup Object ObjectList
@brief Definition of the ObjectListBase class.
The ObjectListBase is a double-linked list, used by Identifiers to store all objects of a given class.
Modified: code/branches/doc/src/libraries/core/ObjectListIterator.h
===================================================================
--- code/branches/doc/src/libraries/core/ObjectListIterator.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ObjectListIterator.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ @ingroup Object ObjectList
@brief Definition and implementation of the Iterator class.
The ObjectListIterator of a given class allows to iterate through the
Modified: code/branches/doc/src/libraries/core/OrxonoxClass.h
===================================================================
--- code/branches/doc/src/libraries/core/OrxonoxClass.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/OrxonoxClass.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,13 @@
*/
/**
+ @defgroup OrxonoxClass OrxonoxClass
+ @ingroup Class
+*/
+
+/**
@file
+ @ingroup Class OrxonoxClass
@brief Declaration of the OrxonoxClass Class.
All objects and interfaces of the game-logic (not the engine) are derived from OrxonoxClass.
Modified: code/branches/doc/src/libraries/core/PathConfig.h
===================================================================
--- code/branches/doc/src/libraries/core/PathConfig.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/PathConfig.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup Management Resources
+*/
+
#ifndef _PathConfig_H__
#define _PathConfig_H__
Modified: code/branches/doc/src/libraries/core/Resource.h
===================================================================
--- code/branches/doc/src/libraries/core/Resource.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Resource.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,16 @@
*
*/
+/**
+ @defgroup Resources Resources
+ @ingroup Management
+*/
+
+/**
+ @file
+ @ingroup Management Resources
+*/
+
#ifndef _Core_Resource_H__
#define _Core_Resource_H__
Modified: code/branches/doc/src/libraries/core/SmartPtr.h
===================================================================
--- code/branches/doc/src/libraries/core/SmartPtr.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/SmartPtr.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,16 @@
// Inspired by boost::intrusive_ptr by Peter Dimov
+/**
+ @defgroup SmartPtr SmartPtr<T> and WeakPtr<T>
+ @ingroup Object
+*/
+
+/**
+ @file
+ @ingroup Object SmartPtr
+*/
+
#ifndef _SmartPtr_H__
#define _SmartPtr_H__
Modified: code/branches/doc/src/libraries/core/SubclassIdentifier.h
===================================================================
--- code/branches/doc/src/libraries/core/SubclassIdentifier.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/SubclassIdentifier.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,7 @@
/**
@file
+ @ingroup Class Identifier
@brief Definition of SubclassIdentifier.
SubclassIdentifier is a separated class, acting like an Identifier, but has a given class.
Modified: code/branches/doc/src/libraries/core/Super.h
===================================================================
--- code/branches/doc/src/libraries/core/Super.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Super.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,13 @@
*/
/**
+ @defgroup Super Super
+ @ingroup Class
+*/
+
+/**
@file
+ @ingroup Class Super
@brief Definition of all super-function related macros.
This file defines all macros needed to add a new "super-function".
Modified: code/branches/doc/src/libraries/core/Template.h
===================================================================
--- code/branches/doc/src/libraries/core/Template.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Template.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,16 @@
*
*/
+/**
+ @defgroup Template Template
+ @ingroup XML
+*/
+
+/**
+ @file
+ @ingroup XML Template
+*/
+
#ifndef _Template_H__
#define _Template_H__
Modified: code/branches/doc/src/libraries/core/Thread.h
===================================================================
--- code/branches/doc/src/libraries/core/Thread.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/Thread.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup ThreadPool
+*/
+
#ifndef _Thread_H__
#define _Thread_H__
Modified: code/branches/doc/src/libraries/core/ThreadPool.h
===================================================================
--- code/branches/doc/src/libraries/core/ThreadPool.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ThreadPool.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,16 @@
*
*/
+/**
+ @defgroup ThreadPool Thread pool
+ @ingroup Core
+*/
+
+/**
+ @file
+ @ingroup ThreadPool
+*/
+
#ifndef _ThreadPool_H__
#define _ThreadPool_H__
Modified: code/branches/doc/src/libraries/core/ToluaInterface.h
===================================================================
--- code/branches/doc/src/libraries/core/ToluaInterface.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/ToluaInterface.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,8 @@
/**
@file
+ at ingroup Lua
+ at brief
This is required because tolua would parse this macro in LuaState.h and fail
*/
Modified: code/branches/doc/src/libraries/core/WeakPtr.h
===================================================================
--- code/branches/doc/src/libraries/core/WeakPtr.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/WeakPtr.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -28,6 +28,11 @@
// Inspired by boost::intrusive_ptr by Peter Dimov
+/**
+ @file
+ @ingroup Object SmartPtr
+*/
+
#ifndef _WeakPtr_H__
#define _WeakPtr_H__
Modified: code/branches/doc/src/libraries/core/WindowEventListener.h
===================================================================
--- code/branches/doc/src/libraries/core/WindowEventListener.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/WindowEventListener.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup Graphics
+*/
+
#ifndef _WindowEventListener_H__
#define _WindowEventListener_H__
Modified: code/branches/doc/src/libraries/core/XMLFile.h
===================================================================
--- code/branches/doc/src/libraries/core/XMLFile.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/XMLFile.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup XML XMLPort
+*/
+
#ifndef _XMLFile_H__
#define _XMLFile_H__
Modified: code/branches/doc/src/libraries/core/XMLNameListener.h
===================================================================
--- code/branches/doc/src/libraries/core/XMLNameListener.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/XMLNameListener.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -26,6 +26,11 @@
*
*/
+/**
+ @file
+ @ingroup XML XMLPort
+*/
+
#ifndef _XMLNameListener_H__
#define _XMLNameListener_H__
Modified: code/branches/doc/src/libraries/core/XMLPort.h
===================================================================
--- code/branches/doc/src/libraries/core/XMLPort.h 2010-09-05 21:11:22 UTC (rev 7362)
+++ code/branches/doc/src/libraries/core/XMLPort.h 2010-09-06 00:15:49 UTC (rev 7363)
@@ -27,7 +27,13 @@
*/
/**
+ @defgroup XMLPort XMLPort
+ @ingroup XML
+*/
+
+/**
@file
+ @ingroup XML XMLPort
@brief Declaration of the XMLPort helper classes and macros.
XMLPort is a virtual function of every BaseObject. Every object can change this function.
More information about the Orxonox-commit
mailing list