diff options
author | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-22 15:42:55 +0300 |
---|---|---|
committer | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-22 15:42:55 +0300 |
commit | 79f79e0cacd0dbf2b7202cdf929487b6825aa715 (patch) | |
tree | bf5238128b2ba711a795e3c5f43ec82ca9f4a9c7 | |
parent | eac95abdf2087ad6dbacf088cb22dd1efebfc247 (diff) |
doxygen: BGE Network, Physics, Rasterizer
51 files changed, 299 insertions, 63 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index e122345288d..a7a24c881fc 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -637,7 +637,10 @@ INPUT = doxygen.main \ ../source/gameengine/Expressions \ ../source/gameengine/GameLogic \ ../source/gameengine/GamePlayer \ - ../source/gameengine/Ketsji + ../source/gameengine/Ketsji \ + ../source/gameengine/Rasterizer \ + ../source/gameengine/Network \ + ../source/gameengine/Physics # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is diff --git a/doc/doxygen.main b/doc/doxygen.main index a24c6d86449..290851c7a9c 100644 --- a/doc/doxygen.main +++ b/doc/doxygen.main @@ -6,6 +6,7 @@ * * These pages document the source code of blender. * + * * For more information on using Blender browse to http://www.blender.org * */ @@ -70,6 +71,30 @@ /** \defgroup ketsjinet Ketsji Network * \ingroup ketsji */ +/** \defgroup bgenet Network + * \ingroup bge + */ +/** \defgroup bgenetlb Loopback Network + * \ingroup bgenet + */ +/** \defgroup phys Physics + * \ingroup bge + */ +/** \defgroup physbullet Bullet Physics + * \ingroup phys + */ +/** \defgroup physdummy Dummy Physics (none) + * \ingroup phys + */ +/** \defgroup bgerast Rasterizer + * \ingroup bge + */ +/** \defgroup bgerastoglfilters OpenGL Filters + * \ingroup bgerast + */ +/** \defgroup bgerastogl OpenGL Rasterizer + * \ingroup bgerast + */ /** \defgroup audaspace Audaspace * \ingroup intern undoc diff --git a/source/gameengine/Ketsji/KX_WorldIpoController.h b/source/gameengine/Ketsji/KX_WorldIpoController.h index bd87286bb41..7771628b5bc 100644 --- a/source/gameengine/Ketsji/KX_WorldIpoController.h +++ b/source/gameengine/Ketsji/KX_WorldIpoController.h @@ -47,7 +47,7 @@ public: private: T_InterpolatorList m_interpolators; - unsigned short m_modify_mist_color : 1; + unsigned short m_modify_mist_color : 1; unsigned short m_modify_mist_start : 1; unsigned short m_modify_mist_dist : 1; bool m_modified; diff --git a/source/gameengine/Network/LoopBackNetwork/NG_LoopBackNetworkDeviceInterface.h b/source/gameengine/Network/LoopBackNetwork/NG_LoopBackNetworkDeviceInterface.h index bb15c3239ee..67d0e741507 100644 --- a/source/gameengine/Network/LoopBackNetwork/NG_LoopBackNetworkDeviceInterface.h +++ b/source/gameengine/Network/LoopBackNetwork/NG_LoopBackNetworkDeviceInterface.h @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * LoopbackNetworkDeviceInterface derived from NG_NetworkDeviceInterface + */ + +/** \file NG_LoopBackNetworkDeviceInterface.h + * \ingroup bgenetlb + * \brief LoopbackNetworkDeviceInterface derived from NG_NetworkDeviceInterface */ #ifndef NG_LOOPBACKNETWORKDEVICEINTERFACE_H #define NG_LOOPBACKNETWORKDEVICEINTERFACE_H diff --git a/source/gameengine/Network/NG_NetworkDeviceInterface.h b/source/gameengine/Network/NG_NetworkDeviceInterface.h index 5925870272d..6df228680ec 100644 --- a/source/gameengine/Network/NG_NetworkDeviceInterface.h +++ b/source/gameengine/Network/NG_NetworkDeviceInterface.h @@ -25,10 +25,14 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * NetworkGameengine_NetworkDeviceInterface - * Functions like (de)initialize network, get library version + */ + +/** \file NG_NetworkDeviceInterface.h + * \ingroup bgenet + * \brief Functions like (de)initialize network, get library version * To be derived by loopback and network libraries */ + #ifndef NG_NETWORKDEVICEINTERFACE_H #define NG_NETWORKDEVICEINTERFACE_H diff --git a/source/gameengine/Network/NG_NetworkMessage.h b/source/gameengine/Network/NG_NetworkMessage.h index 0d43e3c2b51..0163e18fde7 100644 --- a/source/gameengine/Network/NG_NetworkMessage.h +++ b/source/gameengine/Network/NG_NetworkMessage.h @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * NetworkGame_NetworkMessage generic Network Message class + */ + +/** \file NG_NetworkMessage.h + * \ingroup bgenet + * \brief generic Network Message class */ #ifndef NG_NETWORKMESSAGE_H #define NG_NETWORKMESSAGE_H diff --git a/source/gameengine/Network/NG_NetworkObject.h b/source/gameengine/Network/NG_NetworkObject.h index 7bdd25305a0..0cbb3c83779 100644 --- a/source/gameengine/Network/NG_NetworkObject.h +++ b/source/gameengine/Network/NG_NetworkObject.h @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * NetworkGame_NetworkObject generic Network Object class + */ + +/** \file NG_NetworkObject.h + * \ingroup bgenet + * \brief generic Network Object class */ #ifndef NG_NETWORKOBJECT_H #define NG_NETWORKOBJECT_H diff --git a/source/gameengine/Network/NG_NetworkScene.h b/source/gameengine/Network/NG_NetworkScene.h index 60bb0b09097..d390eabc465 100644 --- a/source/gameengine/Network/NG_NetworkScene.h +++ b/source/gameengine/Network/NG_NetworkScene.h @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * NetworkSceneManagement generic class + */ + +/** \file NG_NetworkScene.h + * \ingroup bgenet + * \brief NetworkSceneManagement generic class */ #ifndef __NG_NETWORKSCENE_H #define __NG_NETWORKSCENE_H diff --git a/source/gameengine/Physics/Bullet/CcdGraphicController.h b/source/gameengine/Physics/Bullet/CcdGraphicController.h index 97893420d79..d0cb899cb74 100644 --- a/source/gameengine/Physics/Bullet/CcdGraphicController.h +++ b/source/gameengine/Physics/Bullet/CcdGraphicController.h @@ -13,6 +13,10 @@ subject to the following restrictions: 3. This notice may not be removed or altered from any source distribution. */ +/** \file CcdGraphicController.h + * \ingroup physbullet + */ + #ifndef BULLET2_GRAPHICCONTROLLER_H #define BULLET2_GRAPHICCONTROLLER_H diff --git a/source/gameengine/Physics/Bullet/CcdPhysicsController.h b/source/gameengine/Physics/Bullet/CcdPhysicsController.h index 3bbe17459c9..dc7a88e8db1 100644 --- a/source/gameengine/Physics/Bullet/CcdPhysicsController.h +++ b/source/gameengine/Physics/Bullet/CcdPhysicsController.h @@ -13,6 +13,10 @@ subject to the following restrictions: 3. This notice may not be removed or altered from any source distribution. */ +/** \file CcdPhysicsController.h + * \ingroup physbullet + */ + #ifndef BULLET2_PHYSICSCONTROLLER_H #define BULLET2_PHYSICSCONTROLLER_H diff --git a/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h b/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h index c6e759743a9..2dbd384e373 100644 --- a/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h +++ b/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h @@ -13,6 +13,10 @@ subject to the following restrictions: 3. This notice may not be removed or altered from any source distribution. */ +/** \file CcdPhysicsEnvironment.h + * \ingroup physbullet + */ + #ifndef CCDPHYSICSENVIRONMENT #define CCDPHYSICSENVIRONMENT @@ -47,10 +51,11 @@ class btIDebugDraw; class PHY_IVehicle; class CcdOverlapFilterCallBack; -/// CcdPhysicsEnvironment is an experimental mainloop for physics simulation using optional continuous collision detection. -/// Physics Environment takes care of stepping the simulation and is a container for physics entities. -/// It stores rigidbodies,constraints, materials etc. -/// A derived class may be able to 'construct' entities by loading and/or converting +/** CcdPhysicsEnvironment is an experimental mainloop for physics simulation using optional continuous collision detection. + * Physics Environment takes care of stepping the simulation and is a container for physics entities. + * It stores rigidbodies,constraints, materials etc. + * A derived class may be able to 'construct' entities by loading and/or converting + */ class CcdPhysicsEnvironment : public PHY_IPhysicsEnvironment { friend class CcdOverlapFilterCallBack; diff --git a/source/gameengine/Physics/Dummy/DummyPhysicsEnvironment.h b/source/gameengine/Physics/Dummy/DummyPhysicsEnvironment.h index 0ad6649f2e5..b3deb181a44 100644 --- a/source/gameengine/Physics/Dummy/DummyPhysicsEnvironment.h +++ b/source/gameengine/Physics/Dummy/DummyPhysicsEnvironment.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file DummyPhysicsEnvironment.h + * \ingroup physdummy + */ + #ifndef _DUMMYPHYSICSENVIRONMENT #define _DUMMYPHYSICSENVIRONMENT diff --git a/source/gameengine/Physics/common/PHY_DynamicTypes.h b/source/gameengine/Physics/common/PHY_DynamicTypes.h index cc0f06a58cf..a1761131a8e 100644 --- a/source/gameengine/Physics/common/PHY_DynamicTypes.h +++ b/source/gameengine/Physics/common/PHY_DynamicTypes.h @@ -13,6 +13,9 @@ subject to the following restrictions: 3. This notice may not be removed or altered from any source distribution. */ +/** \file PHY_DynamicTypes.h + * \ingroup phys + */ #ifndef __PHY_DYNAMIC_TYPES #define __PHY_DYNAMIC_TYPES diff --git a/source/gameengine/Physics/common/PHY_IController.h b/source/gameengine/Physics/common/PHY_IController.h index de2e53c3613..d3bb9fbf5bc 100644 --- a/source/gameengine/Physics/common/PHY_IController.h +++ b/source/gameengine/Physics/common/PHY_IController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file PHY_IController.h + * \ingroup phys + */ + #ifndef PHY_ICONTROLLER_H #define PHY_ICONTROLLER_H diff --git a/source/gameengine/Physics/common/PHY_IGraphicController.h b/source/gameengine/Physics/common/PHY_IGraphicController.h index aeccdb573b4..57cabb09557 100644 --- a/source/gameengine/Physics/common/PHY_IGraphicController.h +++ b/source/gameengine/Physics/common/PHY_IGraphicController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file PHY_IGraphicsController.h + * \ingroup phys + */ + #ifndef PHY_IGRAPHICCONTROLLER_H #define PHY_IGRAPHICCONTROLLER_H diff --git a/source/gameengine/Physics/common/PHY_IMotionState.h b/source/gameengine/Physics/common/PHY_IMotionState.h index a644bb319ae..00b4f105348 100644 --- a/source/gameengine/Physics/common/PHY_IMotionState.h +++ b/source/gameengine/Physics/common/PHY_IMotionState.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file PHY_IMotionState.h + * \ingroup phys + */ + #ifndef PHY__MOTIONSTATE_H #define PHY__MOTIONSTATE_H diff --git a/source/gameengine/Physics/common/PHY_IPhysicsController.h b/source/gameengine/Physics/common/PHY_IPhysicsController.h index 82baa8c47e1..eaf756d887f 100644 --- a/source/gameengine/Physics/common/PHY_IPhysicsController.h +++ b/source/gameengine/Physics/common/PHY_IPhysicsController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file PHY_IPhysicsController.h + * \ingroup phys + */ + #ifndef PHY_IPHYSICSCONTROLLER_H #define PHY_IPHYSICSCONTROLLER_H diff --git a/source/gameengine/Physics/common/PHY_IPhysicsEnvironment.h b/source/gameengine/Physics/common/PHY_IPhysicsEnvironment.h index abce2769f2a..e2a9b5e99e4 100644 --- a/source/gameengine/Physics/common/PHY_IPhysicsEnvironment.h +++ b/source/gameengine/Physics/common/PHY_IPhysicsEnvironment.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file PHY_IPhysicsEnvironment.h + * \ingroup phys + */ + #ifndef _IPHYSICSENVIRONMENT #define _IPHYSICSENVIRONMENT diff --git a/source/gameengine/Physics/common/PHY_IVehicle.h b/source/gameengine/Physics/common/PHY_IVehicle.h index 7c00b5d0bef..da9daa29977 100644 --- a/source/gameengine/Physics/common/PHY_IVehicle.h +++ b/source/gameengine/Physics/common/PHY_IVehicle.h @@ -1,3 +1,8 @@ + +/** \file PHY_IVehicle.h + * \ingroup phys + */ + #ifndef PHY_IVEHICLE_H #define PHY_IVEHICLE_H diff --git a/source/gameengine/Physics/common/PHY_Pro.h b/source/gameengine/Physics/common/PHY_Pro.h index d51992da372..4ee8d3a4293 100644 --- a/source/gameengine/Physics/common/PHY_Pro.h +++ b/source/gameengine/Physics/common/PHY_Pro.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file PHY_Pro.h + * \ingroup phys + */ + #ifndef PHY_PROPSH #define PHY_PROPSH diff --git a/source/gameengine/Rasterizer/RAS_2DFilterManager.h b/source/gameengine/Rasterizer/RAS_2DFilterManager.h index 9671f914fcd..a18df8b4d64 100644 --- a/source/gameengine/Rasterizer/RAS_2DFilterManager.h +++ b/source/gameengine/Rasterizer/RAS_2DFilterManager.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_2DFilterManager.h + * \ingroup bgerast + */ + #ifndef __RAS_I2DFILTER #define __RAS_I2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_BucketManager.h b/source/gameengine/Rasterizer/RAS_BucketManager.h index 487df50802c..297782bd4fe 100644 --- a/source/gameengine/Rasterizer/RAS_BucketManager.h +++ b/source/gameengine/Rasterizer/RAS_BucketManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,7 +26,10 @@ * * ***** END GPL LICENSE BLOCK ***** */ -// this will be put in a class later on + +/** \file RAS_BucketManager.h + * \ingroup bgerast + */ #ifndef __RAS_BUCKETMANAGER #define __RAS_BUCKETMANAGER diff --git a/source/gameengine/Rasterizer/RAS_CameraData.h b/source/gameengine/Rasterizer/RAS_CameraData.h index 01f8d491a35..e6254f72511 100644 --- a/source/gameengine/Rasterizer/RAS_CameraData.h +++ b/source/gameengine/Rasterizer/RAS_CameraData.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_CameraData.h + * \ingroup bgerast + */ + #ifndef __RAS_CAMERADATA_H #define __RAS_CAMERADATA_H diff --git a/source/gameengine/Rasterizer/RAS_Deformer.h b/source/gameengine/Rasterizer/RAS_Deformer.h index 37543092e68..8678830f6a2 100644 --- a/source/gameengine/Rasterizer/RAS_Deformer.h +++ b/source/gameengine/Rasterizer/RAS_Deformer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Deformer.h + * \ingroup bgerast + */ + #ifndef RAS_DEFORMER #define RAS_DEFORMER diff --git a/source/gameengine/Rasterizer/RAS_FramingManager.h b/source/gameengine/Rasterizer/RAS_FramingManager.h index aedac230cbe..c37d92dac17 100644 --- a/source/gameengine/Rasterizer/RAS_FramingManager.h +++ b/source/gameengine/Rasterizer/RAS_FramingManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_FramingManager.h + * \ingroup bgerast + */ + #ifndef RAS_FRAMINGMANAGER_H #define RAS_FRAMINGMANAGER_H diff --git a/source/gameengine/Rasterizer/RAS_ICanvas.h b/source/gameengine/Rasterizer/RAS_ICanvas.h index 826fe732b94..41374a476c6 100644 --- a/source/gameengine/Rasterizer/RAS_ICanvas.h +++ b/source/gameengine/Rasterizer/RAS_ICanvas.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,20 +26,23 @@ * * ***** END GPL LICENSE BLOCK ***** */ -#ifndef __RAS_ICANVAS -#define __RAS_ICANVAS -/** - * 2D rendering device context. The connection from 3d rendercontext to 2d surface. +/** \file RAS_ICanvas.h + * \ingroup bgerast */ +#ifndef __RAS_ICANVAS +#define __RAS_ICANVAS + #ifdef WITH_CXX_GUARDEDALLOC #include "MEM_guardedalloc.h" #endif class RAS_Rect; - +/** + * 2D rendering device context. The connection from 3d rendercontext to 2d surface. + */ class RAS_ICanvas { public: diff --git a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h index 59554e31c36..b0e7daf81d7 100644 --- a/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h +++ b/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,15 +26,16 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_IPolygonMaterial.h + * \ingroup bgerast + */ + #ifndef __RAS_IPOLYGONMATERIAL #define __RAS_IPOLYGONMATERIAL #include "STR_HashedString.h" -/** - * Polygon Material on which the material buckets are sorted - * - */ #include "MT_Vector3.h" #include "STR_HashedString.h" @@ -65,7 +66,8 @@ enum MaterialProps }; /** - * Material properties. + * Polygon Material on which the material buckets are sorted + * */ class RAS_IPolyMaterial { diff --git a/source/gameengine/Rasterizer/RAS_IRasterizer.h b/source/gameengine/Rasterizer/RAS_IRasterizer.h index d72e910cd2c..f76799953a1 100644 --- a/source/gameengine/Rasterizer/RAS_IRasterizer.h +++ b/source/gameengine/Rasterizer/RAS_IRasterizer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_IRasterizer.h + * \ingroup bgerast + */ + #ifndef __RAS_IRASTERIZER #define __RAS_IRASTERIZER diff --git a/source/gameengine/Rasterizer/RAS_IRenderTools.h b/source/gameengine/Rasterizer/RAS_IRenderTools.h index dab28de27f4..ce20bbd98cd 100644 --- a/source/gameengine/Rasterizer/RAS_IRenderTools.h +++ b/source/gameengine/Rasterizer/RAS_IRenderTools.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_IRenderTools.h + * \ingroup bgerast + */ + #ifndef __RAS_IRENDERTOOLS #define __RAS_IRENDERTOOLS diff --git a/source/gameengine/Rasterizer/RAS_LightObject.h b/source/gameengine/Rasterizer/RAS_LightObject.h index 54bc5730564..ef6cfa06635 100644 --- a/source/gameengine/Rasterizer/RAS_LightObject.h +++ b/source/gameengine/Rasterizer/RAS_LightObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_LightObject.h + * \ingroup bgerast + */ + #ifndef __RAS_LIGHTOBJECT_H #define __RAS_LIGHTOBJECT_H diff --git a/source/gameengine/Rasterizer/RAS_MaterialBucket.h b/source/gameengine/Rasterizer/RAS_MaterialBucket.h index c9ccac8e8a7..c46a36768ee 100644 --- a/source/gameengine/Rasterizer/RAS_MaterialBucket.h +++ b/source/gameengine/Rasterizer/RAS_MaterialBucket.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_MaterialBucket.h + * \ingroup bgerast + */ + #ifndef __RAS_MATERIALBUCKET #define __RAS_MATERIALBUCKET diff --git a/source/gameengine/Rasterizer/RAS_MeshObject.h b/source/gameengine/Rasterizer/RAS_MeshObject.h index 11499b4fbcb..0b35b212e1d 100644 --- a/source/gameengine/Rasterizer/RAS_MeshObject.h +++ b/source/gameengine/Rasterizer/RAS_MeshObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_MeshObject.h + * \ingroup bgerast + */ + #ifndef __RAS_MESHOBJECT #define __RAS_MESHOBJECT diff --git a/source/gameengine/Rasterizer/RAS_ObjectColor.h b/source/gameengine/Rasterizer/RAS_ObjectColor.h index e4bca39ff3a..9a334385b17 100644 --- a/source/gameengine/Rasterizer/RAS_ObjectColor.h +++ b/source/gameengine/Rasterizer/RAS_ObjectColor.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_ObjectColor.h + * \ingroup bgerast + */ + #ifndef __RAS_OBJECTCOLOR_H #define __RAS_OBJECTCOLOR_H diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Blur2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Blur2DFilter.h index ff92a912ec1..a277d9835d8 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Blur2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Blur2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Blur2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_BLUR2DFILTER #define __RAS_BLUR2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Dilation2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Dilation2DFilter.h index 87335761729..6aeff254f77 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Dilation2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Dilation2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Dilation2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_DILATION2DFILTER #define __RAS_DILATION2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Erosion2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Erosion2DFilter.h index 476f5820158..1e9dccaec87 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Erosion2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Erosion2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Erosion2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_EROSION2DFILTER #define __RAS_EROSION2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_GrayScale2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_GrayScale2DFilter.h index 914151944a5..422d6dfa1b3 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_GrayScale2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_GrayScale2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_GrayScale2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_GRAYSCALE2DFILTER #define __RAS_GRAYSCALE2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Invert2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Invert2DFilter.h index afab58d4048..475f3506c2c 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Invert2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Invert2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Invert2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_INVERT2DFILTER #define __RAS_INVERT2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Laplacian2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Laplacian2DFilter.h index 51a835706bf..c7cfa83a11f 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Laplacian2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Laplacian2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Laplacian2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_LAPLACION2DFILTER #define __RAS_LAPLACION2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Prewitt2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Prewitt2DFilter.h index 62842d5f0a8..ada53cd751d 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Prewitt2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Prewitt2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Prewitt2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_PREWITT2DFILTER #define __RAS_PREWITT2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sepia2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sepia2DFilter.h index 296b54242bf..5c1c18c30c1 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sepia2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sepia2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Sepia2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_SEPIA2DFILTER #define __RAS_SEPIA2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sharpen2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sharpen2DFilter.h index 6b9cc74f424..0d68bc09c70 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sharpen2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sharpen2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Sharpen2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_SHARPEN2DFILTER #define __RAS_SHARPEN2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sobel2DFilter.h b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sobel2DFilter.h index f8efe469bfc..0f80f0f22b4 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sobel2DFilter.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sobel2DFilter.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Sobel2DFilter.h + * \ingroup bgerastoglfilters + */ + #ifndef __RAS_SOBEL2DFILTER #define __RAS_SOBEL2DFILTER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_GLExtensionManager.h b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_GLExtensionManager.h index 2f5d90d4bb5..c8a8a68e3ec 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_GLExtensionManager.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_GLExtensionManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * ***** BEGIN GPL LICENSE BLOCK ***** * @@ -26,6 +26,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_GLExtensionManager.h + * \ingroup bgerastogl + */ + #ifndef __RAS_GLEXTENSIONMANAGER_H__ #define __RAS_GLEXTENSIONMANAGER_H__ diff --git a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_ListRasterizer.h b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_ListRasterizer.h index 28c56b92c3c..0b36bbf3876 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_ListRasterizer.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_ListRasterizer.h @@ -1,3 +1,8 @@ + +/** \file RAS_ListRasterizer.h + * \ingroup bgerastogl + */ + #ifndef __RAS_LISTRASTERIZER_H__ #define __RAS_LISTRASTERIZER_H__ diff --git a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h index 387bb2cfd73..54fab906049 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_OpenGLRasterizer.h + * \ingroup bgerastogl + */ + #ifndef __RAS_OPENGLRASTERIZER #define __RAS_OPENGLRASTERIZER diff --git a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_VAOpenGLRasterizer.h b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_VAOpenGLRasterizer.h index 96f6344b403..388d6c4da29 100644 --- a/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_VAOpenGLRasterizer.h +++ b/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_VAOpenGLRasterizer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_VAOpenGLRasterizer.h + * \ingroup bgerastogl + */ + #ifndef __KX_VERTEXARRAYOPENGLRASTERIZER #define __KX_VERTEXARRAYOPENGLRASTERIZER diff --git a/source/gameengine/Rasterizer/RAS_Polygon.h b/source/gameengine/Rasterizer/RAS_Polygon.h index 8dc9813f5b9..49e99f6bd2f 100644 --- a/source/gameengine/Rasterizer/RAS_Polygon.h +++ b/source/gameengine/Rasterizer/RAS_Polygon.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_Polygon.h + * \ingroup bgerast + */ + #ifndef __RAS_POLYGON #define __RAS_POLYGON diff --git a/source/gameengine/Rasterizer/RAS_Rect.h b/source/gameengine/Rasterizer/RAS_Rect.h index 7a1d21b8905..bc4f069b883 100644 --- a/source/gameengine/Rasterizer/RAS_Rect.h +++ b/source/gameengine/Rasterizer/RAS_Rect.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file RAS_Rect.h + * \ingroup bgerast + */ + #ifndef _RAS_RECT #define _RAS_RECT @@ -35,11 +39,10 @@ #endif /** - * @section interface class. + * \section interface class. * RAS_Rect just encodes a simple rectangle. - * Should be part of a generic library + * \note Should be part of a generic library */ - class RAS_Rect { public: // todo: make a decent class, and make private diff --git a/source/gameengine/Rasterizer/RAS_TexMatrix.h b/source/gameengine/Rasterizer/RAS_TexMatrix.h index ef500a8084b..068e810e387 100644 --- a/source/gameengine/Rasterizer/RAS_TexMatrix.h +++ b/source/gameengine/Rasterizer/RAS_TexMatrix.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_TexMatrix.h + * \ingroup bgerast + */ + #ifndef __RASTEXMATRIX #define __RASTEXMATRIX diff --git a/source/gameengine/Rasterizer/RAS_TexVert.h b/source/gameengine/Rasterizer/RAS_TexVert.h index bdf2a6487ad..bbccd3cca9d 100644 --- a/source/gameengine/Rasterizer/RAS_TexVert.h +++ b/source/gameengine/Rasterizer/RAS_TexVert.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file RAS_TexVert.h + * \ingroup bgerast + */ + #ifndef __RAS_TEXVERT #define __RAS_TEXVERT |