doxygen: BGE Network, Physics, Rasterizer
authorNathan Letwory <nathan@letworyinteractive.com>
Tue, 22 Feb 2011 12:42:55 +0000 (12:42 +0000)
committerNathan Letwory <nathan@letworyinteractive.com>
Tue, 22 Feb 2011 12:42:55 +0000 (12:42 +0000)
51 files changed:
doc/Doxyfile
doc/doxygen.main
source/gameengine/Ketsji/KX_WorldIpoController.h
source/gameengine/Network/LoopBackNetwork/NG_LoopBackNetworkDeviceInterface.h
source/gameengine/Network/NG_NetworkDeviceInterface.h
source/gameengine/Network/NG_NetworkMessage.h
source/gameengine/Network/NG_NetworkObject.h
source/gameengine/Network/NG_NetworkScene.h
source/gameengine/Physics/Bullet/CcdGraphicController.h
source/gameengine/Physics/Bullet/CcdPhysicsController.h
source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h
source/gameengine/Physics/Dummy/DummyPhysicsEnvironment.h
source/gameengine/Physics/common/PHY_DynamicTypes.h
source/gameengine/Physics/common/PHY_IController.h
source/gameengine/Physics/common/PHY_IGraphicController.h
source/gameengine/Physics/common/PHY_IMotionState.h
source/gameengine/Physics/common/PHY_IPhysicsController.h
source/gameengine/Physics/common/PHY_IPhysicsEnvironment.h
source/gameengine/Physics/common/PHY_IVehicle.h
source/gameengine/Physics/common/PHY_Pro.h
source/gameengine/Rasterizer/RAS_2DFilterManager.h
source/gameengine/Rasterizer/RAS_BucketManager.h
source/gameengine/Rasterizer/RAS_CameraData.h
source/gameengine/Rasterizer/RAS_Deformer.h
source/gameengine/Rasterizer/RAS_FramingManager.h
source/gameengine/Rasterizer/RAS_ICanvas.h
source/gameengine/Rasterizer/RAS_IPolygonMaterial.h
source/gameengine/Rasterizer/RAS_IRasterizer.h
source/gameengine/Rasterizer/RAS_IRenderTools.h
source/gameengine/Rasterizer/RAS_LightObject.h
source/gameengine/Rasterizer/RAS_MaterialBucket.h
source/gameengine/Rasterizer/RAS_MeshObject.h
source/gameengine/Rasterizer/RAS_ObjectColor.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Blur2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Dilation2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Erosion2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_GrayScale2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Invert2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Laplacian2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Prewitt2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sepia2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sharpen2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sobel2DFilter.h
source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_GLExtensionManager.h
source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_ListRasterizer.h
source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h
source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_VAOpenGLRasterizer.h
source/gameengine/Rasterizer/RAS_Polygon.h
source/gameengine/Rasterizer/RAS_Rect.h
source/gameengine/Rasterizer/RAS_TexMatrix.h
source/gameengine/Rasterizer/RAS_TexVert.h

index e122345288d71fd912a3077f16ebae3de4beaaec..a7a24c881fc71c09b753faba99acb3af07542a89 100644 (file)
@@ -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 
index a24c6d86449ec8744ca2c14c31b4218b3bceb42e..290851c7a9c78bdf98feb1a97d97cd0d7141eb3c 100644 (file)
@@ -6,6 +6,7 @@
  *
  * These pages document the source code of blender.
  *
+ *
  * For more information on using Blender browse to http://www.blender.org
  *
  */
 /** \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
index bd87286bb418f1a56e35337da90a0e3ee33a6bc4..7771628b5bcfdca7bee89107a66e086b053451d0 100644 (file)
@@ -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;
index bb15c3239ee41b337f5b81c9b17653cf2c83cdac..67d0e741507f51f454dc0e06dbb808ed7551a5c1 100644 (file)
  * 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
index 5925870272dae31160d34964ff2144d5a48b1ae2..6df228680ec44ac70d90801b5d7751d624316194 100644 (file)
  * 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
 
index 0d43e3c2b510f0920de8af02bf9e148f76bf5ad9..0163e18fde7fcfe1f8c2e9d65150e641da29bc4f 100644 (file)
  * 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
index 7bdd25305a00e9d3bde39a9417c0930b54067f71..0cbb3c83779fc5fa551c36d63d9bc9b93edbdc2d 100644 (file)
  * 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
index 60bb0b090979c978f0322d8e6c3ce9aaf4e07533..d390eabc46546709d9c1ed589374ceffa6dded50 100644 (file)
  * 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
index 97893420d796d6986ca8b07efa5c6762f29706ab..d0cb899cb74ea615602fd86f7f1404b18fd3c7e8 100644 (file)
@@ -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
index 3bbe17459c9559d8f8de62d9cf0933a218cbcac2..dc7a88e8db1657ca9584b00bf89208c22ef360b1 100644 (file)
@@ -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
index c6e759743a9eebb1260de4091bd3df065f246e1c..2dbd384e3734f034735ffc013ba7210380ab8aeb 100644 (file)
@@ -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;
index 0ad6649f2e5364a24da7a8141a110174afdc7781..b3deb181a441027447b4fc52ca3adbe634a0a872 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file DummyPhysicsEnvironment.h
+ *  \ingroup physdummy
+ */
+
 #ifndef _DUMMYPHYSICSENVIRONMENT
 #define _DUMMYPHYSICSENVIRONMENT
 
index cc0f06a58cfdb8695d393d97a413cdb0db5f464e..a1761131a8e983d0e5f1fb474c93eee9630c803c 100644 (file)
@@ -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
index de2e53c3613305aca82acc361d2ac735993d794a..d3bb9fbf5bc36e4977e85227ebae781d3c5c68a3 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file PHY_IController.h
+ *  \ingroup phys
+ */
+
 #ifndef PHY_ICONTROLLER_H
 #define PHY_ICONTROLLER_H
 
index aeccdb573b4556b49cddf5dfbc82170e75f583d3..57cabb095572f2c30e8099bd3a23bb6b89e6763c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file PHY_IGraphicsController.h
+ *  \ingroup phys
+ */
+
 #ifndef PHY_IGRAPHICCONTROLLER_H
 #define PHY_IGRAPHICCONTROLLER_H
 
index a644bb319aebf6ee30bd14671d8706b95c6acbf3..00b4f1053482cc02ff299a9db825359d63882253 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file PHY_IMotionState.h
+ *  \ingroup phys
+ */
+
 #ifndef PHY__MOTIONSTATE_H
 #define PHY__MOTIONSTATE_H
 
index 82baa8c47e110cbb9bd0c01363922d2bebb7b868..eaf756d887f1c50594f3d7f7b0921e74959c09c3 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file PHY_IPhysicsController.h
+ *  \ingroup phys
+ */
+
 #ifndef PHY_IPHYSICSCONTROLLER_H
 #define PHY_IPHYSICSCONTROLLER_H
 
index abce2769f2a4bd4dab83093ae2f591c74a72a3ff..e2a9b5e99e433c29920df7110ac9d5a484f1c88c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file PHY_IPhysicsEnvironment.h
+ *  \ingroup phys
+ */
+
 #ifndef _IPHYSICSENVIRONMENT
 #define _IPHYSICSENVIRONMENT
 
index 7c00b5d0bef2f062ce915d1b20ee7b9eaa5caeba..da9daa299776d41cc87ae9c9ca02daa8f75a7682 100644 (file)
@@ -1,3 +1,8 @@
+
+/** \file PHY_IVehicle.h
+ *  \ingroup phys
+ */
+
 #ifndef PHY_IVEHICLE_H
 #define PHY_IVEHICLE_H
 
index d51992da3727be995b452fde198a9f132806a473..4ee8d3a429317c0d241031e7408333dae3fb9696 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file PHY_Pro.h
+ *  \ingroup phys
+ */
+
 #ifndef PHY_PROPSH
 #define PHY_PROPSH
 
index 9671f914fcdeea7a1845751a53d9adbb72bee3de..a18df8b4d64aa0165f9905f65853b586938c3fc3 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_2DFilterManager.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_I2DFILTER
 #define __RAS_I2DFILTER
 
index 487df50802c1cf87669a97ddd06e5dbb60dca95b..297782bd4feba2d8fc3bdd9a8e2589a45e7ee96f 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** 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
index 01f8d491a353b1000d64d782605b0d7d83f550cd..e6254f725118e1b9f2837aac9a975f74ba77e195 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_CameraData.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_CAMERADATA_H
 #define __RAS_CAMERADATA_H
 
index 37543092e6858586e400eaed785fef2bcb2ab87d..8678830f6a24150a4bcf3f196e36ef8a066df977 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Deformer.h
+ *  \ingroup bgerast
+ */
+
 #ifndef RAS_DEFORMER
 #define RAS_DEFORMER
 
index aedac230cbe249ca5dfd2457c53c9aad153c4296..c37d92dac170147345b5979074db87bcc38e9f6c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_FramingManager.h
+ *  \ingroup bgerast
+ */
+
 #ifndef RAS_FRAMINGMANAGER_H
 #define RAS_FRAMINGMANAGER_H
 
index 826fe732b949d65be4b97634d444dc20c49ff263..41374a476c6e5c135772189a4ced08a85bb316bf 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** 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:
index 59554e31c367b083dbea5c2166ddd5dd97707a28..b0e7daf81d760b72c7db1b6653c3a4aa09cb4280 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** 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
 {
index d72e910cd2c0962f9e689b35a7a03c1f2d211b68..f76799953a16d318c7884d6d1c8ee5cb2b3926f5 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_IRasterizer.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_IRASTERIZER
 #define __RAS_IRASTERIZER
 
index dab28de27f4dec138b53083bd17c8667c4f444af..ce20bbd98cd1bac6eb5a595959010e9a9ca8e246 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_IRenderTools.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_IRENDERTOOLS
 #define __RAS_IRENDERTOOLS
 
index 54bc57305642f9176e8e35da3714cde8bc105188..ef6cfa06635cd59fd2ffd30d5f2315236dac963c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_LightObject.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_LIGHTOBJECT_H
 #define __RAS_LIGHTOBJECT_H
 
index c9ccac8e8a759a9abac32b41ef9e5e8f130637c3..c46a36768ee27c936466d6ccd1f25fe882853955 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_MaterialBucket.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_MATERIALBUCKET
 #define __RAS_MATERIALBUCKET
 
index 11499b4fbcbf537d819fd5647afebbc16342cba3..0b35b212e1daf72ea41f1b1ed5b0a17e750ea265 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_MeshObject.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_MESHOBJECT
 #define __RAS_MESHOBJECT
 
index e4bca39ff3a4dd7ba82a1f3af4e95fe9bd2adf4b..9a334385b1777a31d7fa1c4c5d1c337f26ae8ade 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_ObjectColor.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_OBJECTCOLOR_H
 #define __RAS_OBJECTCOLOR_H
 
index ff92a912ec11275aa9e531239c3602651fa7a0b0..a277d9835d812573fe38ddf6aa70c28468b95360 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Blur2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_BLUR2DFILTER
 #define __RAS_BLUR2DFILTER
 
index 8733576172985dde79f3d2f324a8b8c6c6e11bb8..6aeff254f77c272a09db310f03067eec6fe19765 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Dilation2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_DILATION2DFILTER
 #define __RAS_DILATION2DFILTER
 
index 476f5820158b8a4dac676c256e562941bb20412f..1e9dccaec879a7ac140d1a90b70aeafb42a60d1a 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Erosion2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_EROSION2DFILTER
 #define __RAS_EROSION2DFILTER
 
index 914151944a55585292525e19c6f8727f6a5199ca..422d6dfa1b3d04e3f9220b7826bc0bc3a2ad7424 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_GrayScale2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_GRAYSCALE2DFILTER
 #define __RAS_GRAYSCALE2DFILTER
 
index afab58d4048abdf3e4a37b2475e88842d9894d92..475f3506c2cff3f2649e5d1806f0a85601bd3862 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Invert2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_INVERT2DFILTER
 #define __RAS_INVERT2DFILTER
 
index 51a835706bf8d20e6fbaa41093cea547bce6df09..c7cfa83a11f75e6a546d5e9cba858bc9187ef26d 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Laplacian2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_LAPLACION2DFILTER
 #define __RAS_LAPLACION2DFILTER
 
index 62842d5f0a86ac56c2ceb8f848b6dd487058e529..ada53cd751d0bf70c270e5d66b47f58d4eb30244 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Prewitt2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_PREWITT2DFILTER
 #define __RAS_PREWITT2DFILTER
 
index 296b54242bf84ddf59e3090468532384dc3671fc..5c1c18c30c12f4c0c12631a61e153a8e757ed492 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Sepia2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_SEPIA2DFILTER
 #define __RAS_SEPIA2DFILTER
 
index 6b9cc74f424f9e6dfc3516303d1d9f7fd5c78dd3..0d68bc09c70bbe278a1d2807ee7ee9d7e4a5d7d8 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Sharpen2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_SHARPEN2DFILTER
 #define __RAS_SHARPEN2DFILTER
 
index f8efe469bfc7250d98600ed463fdc1554571824e..0f80f0f22b4ef06eeb596223c64efd461eedd2b6 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * This program is free software; you can redistribute it and/or
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Sobel2DFilter.h
+ *  \ingroup bgerastoglfilters
+ */
+
 #ifndef __RAS_SOBEL2DFILTER
 #define __RAS_SOBEL2DFILTER
 
index 2f5d90d4bb59f8c2e4fd03eb7b8ac0db0cd11571..c8a8a68e3ecd1452aed92862040b1502c907fa0a 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_GLExtensionManager.h
+ *  \ingroup bgerastogl
+ */
+
 #ifndef __RAS_GLEXTENSIONMANAGER_H__
 #define __RAS_GLEXTENSIONMANAGER_H__
 
index 28c56b92c3c7760057a2631f39a75543aaa1eca7..0b36bbf38769f8f21a192325d272194d9bffbcee 100644 (file)
@@ -1,3 +1,8 @@
+
+/** \file RAS_ListRasterizer.h
+ *  \ingroup bgerastogl
+ */
+
 #ifndef __RAS_LISTRASTERIZER_H__
 #define __RAS_LISTRASTERIZER_H__
 
index 387bb2cfd73dc73e3de0bda6e42aab183a9d8aeb..54fab906049360d6d3dc54d28347cfc672c2c0ac 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_OpenGLRasterizer.h
+ *  \ingroup bgerastogl
+ */
+
 #ifndef __RAS_OPENGLRASTERIZER
 #define __RAS_OPENGLRASTERIZER
 
index 96f6344b4036492a8ae89c3df8d1f0b5a1690724..388d6c4da29e1bd421972192ffb895e479ab499c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_VAOpenGLRasterizer.h
+ *  \ingroup bgerastogl
+ */
+
 #ifndef __KX_VERTEXARRAYOPENGLRASTERIZER
 #define __KX_VERTEXARRAYOPENGLRASTERIZER
 
index 8dc9813f5b9f73bdbfa4ff179c4aa0f8c5229aa1..49e99f6bd2f8dcfa041af1b1acc48a7e1dce335b 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_Polygon.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_POLYGON
 #define __RAS_POLYGON
 
index 7a1d21b89050f76b081fae8c84a3f8ddeebf8801..bc4f069b88384542fcfa03a0e83010d83a97cbf1 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file RAS_Rect.h
+ *  \ingroup bgerast
+ */
+
 #ifndef _RAS_RECT
 #define _RAS_RECT
 
 #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
index ef500a8084b5584c395de0f64f8c65c10b3d9144..068e810e387c243afd95dd145b27c0d1a074cb2d 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_TexMatrix.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RASTEXMATRIX
 #define __RASTEXMATRIX
 
index bdf2a6487ad6958561fbfdd7d4f252285ee276d6..bbccd3cca9d51bd43551c373b851d8327e0c10ce 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
  *
  * ***** END GPL LICENSE BLOCK *****
  */
+
+/** \file RAS_TexVert.h
+ *  \ingroup bgerast
+ */
+
 #ifndef __RAS_TEXVERT
 #define __RAS_TEXVERT