[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [35072] trunk/blender: doxygen: BGE Network, Physics, Rasterizer
Nathan Letwory
nathan at letworyinteractive.com
Tue Feb 22 13:42:55 CET 2011
Revision: 35072
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=35072
Author: jesterking
Date: 2011-02-22 12:42:55 +0000 (Tue, 22 Feb 2011)
Log Message:
-----------
doxygen: BGE Network, Physics, Rasterizer
Modified Paths:
--------------
trunk/blender/doc/Doxyfile
trunk/blender/doc/doxygen.main
trunk/blender/source/gameengine/Ketsji/KX_WorldIpoController.h
trunk/blender/source/gameengine/Network/LoopBackNetwork/NG_LoopBackNetworkDeviceInterface.h
trunk/blender/source/gameengine/Network/NG_NetworkDeviceInterface.h
trunk/blender/source/gameengine/Network/NG_NetworkMessage.h
trunk/blender/source/gameengine/Network/NG_NetworkObject.h
trunk/blender/source/gameengine/Network/NG_NetworkScene.h
trunk/blender/source/gameengine/Physics/Bullet/CcdGraphicController.h
trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsController.h
trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h
trunk/blender/source/gameengine/Physics/Dummy/DummyPhysicsEnvironment.h
trunk/blender/source/gameengine/Physics/common/PHY_DynamicTypes.h
trunk/blender/source/gameengine/Physics/common/PHY_IController.h
trunk/blender/source/gameengine/Physics/common/PHY_IGraphicController.h
trunk/blender/source/gameengine/Physics/common/PHY_IMotionState.h
trunk/blender/source/gameengine/Physics/common/PHY_IPhysicsController.h
trunk/blender/source/gameengine/Physics/common/PHY_IPhysicsEnvironment.h
trunk/blender/source/gameengine/Physics/common/PHY_IVehicle.h
trunk/blender/source/gameengine/Physics/common/PHY_Pro.h
trunk/blender/source/gameengine/Rasterizer/RAS_2DFilterManager.h
trunk/blender/source/gameengine/Rasterizer/RAS_BucketManager.h
trunk/blender/source/gameengine/Rasterizer/RAS_CameraData.h
trunk/blender/source/gameengine/Rasterizer/RAS_Deformer.h
trunk/blender/source/gameengine/Rasterizer/RAS_FramingManager.h
trunk/blender/source/gameengine/Rasterizer/RAS_ICanvas.h
trunk/blender/source/gameengine/Rasterizer/RAS_IPolygonMaterial.h
trunk/blender/source/gameengine/Rasterizer/RAS_IRasterizer.h
trunk/blender/source/gameengine/Rasterizer/RAS_IRenderTools.h
trunk/blender/source/gameengine/Rasterizer/RAS_LightObject.h
trunk/blender/source/gameengine/Rasterizer/RAS_MaterialBucket.h
trunk/blender/source/gameengine/Rasterizer/RAS_MeshObject.h
trunk/blender/source/gameengine/Rasterizer/RAS_ObjectColor.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Blur2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Dilation2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Erosion2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_GrayScale2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Invert2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Laplacian2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Prewitt2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sepia2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sharpen2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLFilters/RAS_Sobel2DFilter.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_GLExtensionManager.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_ListRasterizer.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_OpenGLRasterizer.h
trunk/blender/source/gameengine/Rasterizer/RAS_OpenGLRasterizer/RAS_VAOpenGLRasterizer.h
trunk/blender/source/gameengine/Rasterizer/RAS_Polygon.h
trunk/blender/source/gameengine/Rasterizer/RAS_Rect.h
trunk/blender/source/gameengine/Rasterizer/RAS_TexMatrix.h
trunk/blender/source/gameengine/Rasterizer/RAS_TexVert.h
Modified: trunk/blender/doc/Doxyfile
===================================================================
--- trunk/blender/doc/Doxyfile 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/doc/Doxyfile 2011-02-22 12:42:55 UTC (rev 35072)
@@ -637,7 +637,10 @@
../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
Modified: trunk/blender/doc/doxygen.main
===================================================================
--- trunk/blender/doc/doxygen.main 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/doc/doxygen.main 2011-02-22 12:42:55 UTC (rev 35072)
@@ -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
Modified: trunk/blender/source/gameengine/Ketsji/KX_WorldIpoController.h
===================================================================
--- trunk/blender/source/gameengine/Ketsji/KX_WorldIpoController.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Ketsji/KX_WorldIpoController.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -47,7 +47,7 @@
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;
Modified: trunk/blender/source/gameengine/Network/LoopBackNetwork/NG_LoopBackNetworkDeviceInterface.h
===================================================================
--- trunk/blender/source/gameengine/Network/LoopBackNetwork/NG_LoopBackNetworkDeviceInterface.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Network/LoopBackNetwork/NG_LoopBackNetworkDeviceInterface.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -25,8 +25,12 @@
* 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
Modified: trunk/blender/source/gameengine/Network/NG_NetworkDeviceInterface.h
===================================================================
--- trunk/blender/source/gameengine/Network/NG_NetworkDeviceInterface.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Network/NG_NetworkDeviceInterface.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -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
Modified: trunk/blender/source/gameengine/Network/NG_NetworkMessage.h
===================================================================
--- trunk/blender/source/gameengine/Network/NG_NetworkMessage.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Network/NG_NetworkMessage.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -25,8 +25,12 @@
* 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
Modified: trunk/blender/source/gameengine/Network/NG_NetworkObject.h
===================================================================
--- trunk/blender/source/gameengine/Network/NG_NetworkObject.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Network/NG_NetworkObject.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -25,8 +25,12 @@
* 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
Modified: trunk/blender/source/gameengine/Network/NG_NetworkScene.h
===================================================================
--- trunk/blender/source/gameengine/Network/NG_NetworkScene.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Network/NG_NetworkScene.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -25,8 +25,12 @@
* 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
Modified: trunk/blender/source/gameengine/Physics/Bullet/CcdGraphicController.h
===================================================================
--- trunk/blender/source/gameengine/Physics/Bullet/CcdGraphicController.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Physics/Bullet/CcdGraphicController.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -13,7 +13,11 @@
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
Modified: trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsController.h
===================================================================
--- trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsController.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsController.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -13,7 +13,11 @@
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
Modified: trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h
===================================================================
--- trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -13,6 +13,10 @@
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 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;
Modified: trunk/blender/source/gameengine/Physics/Dummy/DummyPhysicsEnvironment.h
===================================================================
--- trunk/blender/source/gameengine/Physics/Dummy/DummyPhysicsEnvironment.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Physics/Dummy/DummyPhysicsEnvironment.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -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
Modified: trunk/blender/source/gameengine/Physics/common/PHY_DynamicTypes.h
===================================================================
--- trunk/blender/source/gameengine/Physics/common/PHY_DynamicTypes.h 2011-02-22 12:36:36 UTC (rev 35071)
+++ trunk/blender/source/gameengine/Physics/common/PHY_DynamicTypes.h 2011-02-22 12:42:55 UTC (rev 35072)
@@ -13,6 +13,9 @@
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
Modified: trunk/blender/source/gameengine/Physics/common/PHY_IController.h
===================================================================
--- trunk/blender/source/gameengine/Physics/common/PHY_IController.h 2011-02-22 12:36:36 UTC (rev 35071)
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list