diff options
| author | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-22 13:33:14 +0300 |
|---|---|---|
| committer | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-22 13:33:14 +0300 |
| commit | 5138615554bee47a586209c7f4d3830758ff598e (patch) | |
| tree | d7f8d6409266901db51dd594f762837d427b5b0a /source | |
| parent | 7729ecc98f0e9890ff0fc7c3a49a516b8807bafc (diff) | |
doxygen: entries for blenderroutines, converter, expressions, gamelogic, gameplayer, ketsji
Diffstat (limited to 'source')
186 files changed, 1104 insertions, 349 deletions
diff --git a/source/gameengine/BlenderRoutines/KX_BlenderCanvas.h b/source/gameengine/BlenderRoutines/KX_BlenderCanvas.h index 42f956cafcd..b5b5908e7ae 100644 --- a/source/gameengine/BlenderRoutines/KX_BlenderCanvas.h +++ b/source/gameengine/BlenderRoutines/KX_BlenderCanvas.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_BlenderCanvas.h + * \ingroup blroutines + */ + #ifndef __KX_BLENDERCANVAS #define __KX_BLENDERCANVAS diff --git a/source/gameengine/BlenderRoutines/KX_BlenderGL.h b/source/gameengine/BlenderRoutines/KX_BlenderGL.h index 6d481470517..4e206150081 100644 --- a/source/gameengine/BlenderRoutines/KX_BlenderGL.h +++ b/source/gameengine/BlenderRoutines/KX_BlenderGL.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_BlenderGL.h + * \ingroup blroutines + */ + #ifndef __BLENDERGL #define __BLENDERGL diff --git a/source/gameengine/BlenderRoutines/KX_BlenderInputDevice.h b/source/gameengine/BlenderRoutines/KX_BlenderInputDevice.h index b7f7be4a279..67a2279d824 100644 --- a/source/gameengine/BlenderRoutines/KX_BlenderInputDevice.h +++ b/source/gameengine/BlenderRoutines/KX_BlenderInputDevice.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_BlenderInputDevice.h + * \ingroup blroutines + */ + #ifndef __KX_BLENDERINPUTDEVICE #define __KX_BLENDERINPUTDEVICE diff --git a/source/gameengine/BlenderRoutines/KX_BlenderKeyboardDevice.h b/source/gameengine/BlenderRoutines/KX_BlenderKeyboardDevice.h index eab052895db..b4eb7bf6083 100644 --- a/source/gameengine/BlenderRoutines/KX_BlenderKeyboardDevice.h +++ b/source/gameengine/BlenderRoutines/KX_BlenderKeyboardDevice.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_BlenderKeyboardDevice.h + * \ingroup blroutines + */ + #ifndef __KX_BLENDERKEYBOARDDEVICE #define __KX_BLENDERKEYBOARDDEVICE diff --git a/source/gameengine/BlenderRoutines/KX_BlenderMouseDevice.h b/source/gameengine/BlenderRoutines/KX_BlenderMouseDevice.h index ce067ffb379..e192259e0d7 100644 --- a/source/gameengine/BlenderRoutines/KX_BlenderMouseDevice.h +++ b/source/gameengine/BlenderRoutines/KX_BlenderMouseDevice.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_BlenderMouseDevice.h + * \ingroup blroutines + */ + #ifndef __KX_BLENDERMOUSEDEVICE #define __KX_BLENDERMOUSEDEVICE diff --git a/source/gameengine/BlenderRoutines/KX_BlenderRenderTools.h b/source/gameengine/BlenderRoutines/KX_BlenderRenderTools.h index 7d4728f5ef0..8755ff0a4a1 100644 --- a/source/gameengine/BlenderRoutines/KX_BlenderRenderTools.h +++ b/source/gameengine/BlenderRoutines/KX_BlenderRenderTools.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_BlenderRenderTools.h + * \ingroup blroutines + */ + #ifndef __KX_BLENDERRENDERTOOLS #define __KX_BLENDERRENDERTOOLS diff --git a/source/gameengine/BlenderRoutines/KX_BlenderSystem.h b/source/gameengine/BlenderRoutines/KX_BlenderSystem.h index fb40ded9292..244476d8cf6 100644 --- a/source/gameengine/BlenderRoutines/KX_BlenderSystem.h +++ b/source/gameengine/BlenderRoutines/KX_BlenderSystem.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,12 +26,15 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_BlenderSystem.h + * \ingroup blroutines + * \brief Blender System embedding. Needed when gameengine runs embedded within Blender. + */ + #ifndef __KX_BLENDERSYSTEM #define __KX_BLENDERSYSTEM -/** - * Blender System embedding. Needed when gameengine runs embedded within Blender. - */ #include "KX_ISystem.h" #ifdef WITH_CXX_GUARDEDALLOC @@ -47,8 +50,6 @@ public: virtual ~KX_BlenderSystem() {}; virtual double GetTimeInSeconds(); - - #ifdef WITH_CXX_GUARDEDALLOC public: void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_BlenderSystem"); } diff --git a/source/gameengine/Converter/BL_ActionActuator.h b/source/gameengine/Converter/BL_ActionActuator.h index bfbb160e464..c6e661f1549 100644 --- a/source/gameengine/Converter/BL_ActionActuator.h +++ b/source/gameengine/Converter/BL_ActionActuator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file BL_ActionActuator.h + * \ingroup bgeconv + */ + #ifndef BL_ACTIONACTUATOR #define BL_ACTIONACTUATOR diff --git a/source/gameengine/Converter/BL_ArmatureActuator.h b/source/gameengine/Converter/BL_ArmatureActuator.h index b3f9ee2f1f2..4615fb06714 100644 --- a/source/gameengine/Converter/BL_ArmatureActuator.h +++ b/source/gameengine/Converter/BL_ArmatureActuator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file BL_ArmatureActuator.h + * \ingroup bgeconv + */ + #ifndef BL_ARMATUREACTUATOR #define BL_ARMATUREACTUATOR diff --git a/source/gameengine/Converter/BL_ArmatureChannel.h b/source/gameengine/Converter/BL_ArmatureChannel.h index e1c18215c53..0e3b621292c 100644 --- a/source/gameengine/Converter/BL_ArmatureChannel.h +++ b/source/gameengine/Converter/BL_ArmatureChannel.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file BL_ActionChannel.h + * \ingroup bgeconv + */ + #ifndef __BL_ARMATURECHANNEL #define __BL_ARMATURECHANNEL diff --git a/source/gameengine/Converter/BL_ArmatureConstraint.h b/source/gameengine/Converter/BL_ArmatureConstraint.h index 92da8327edb..1dd685b8cba 100644 --- a/source/gameengine/Converter/BL_ArmatureConstraint.h +++ b/source/gameengine/Converter/BL_ArmatureConstraint.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file BL_ArmatureConstraint.h + * \ingroup bgeconv + */ + #ifndef __BL_ARMATURECONSTRAINT #define __BL_ARMATURECONSTRAINT diff --git a/source/gameengine/Converter/BL_ArmatureObject.h b/source/gameengine/Converter/BL_ArmatureObject.h index 525c265d607..8490bfadac2 100644 --- a/source/gameengine/Converter/BL_ArmatureObject.h +++ b/source/gameengine/Converter/BL_ArmatureObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file BL_ArmatureObject.h + * \ingroup bgeconv + */ + #ifndef BL_ARMATUREOBJECT #define BL_ARMATUREOBJECT diff --git a/source/gameengine/Converter/BL_BlenderDataConversion.h b/source/gameengine/Converter/BL_BlenderDataConversion.h index 66419dbccd1..cea9f7f2a8b 100644 --- a/source/gameengine/Converter/BL_BlenderDataConversion.h +++ b/source/gameengine/Converter/BL_BlenderDataConversion.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file BL_BlenderDataConversion.h + * \ingroup bgeconv + */ + #ifndef __BLENDER_CONVERT #define __BLENDER_CONVERT diff --git a/source/gameengine/Converter/BL_DeformableGameObject.h b/source/gameengine/Converter/BL_DeformableGameObject.h index 12f641eee96..6bcdaff10e3 100644 --- a/source/gameengine/Converter/BL_DeformableGameObject.h +++ b/source/gameengine/Converter/BL_DeformableGameObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file BL_DeformableGameObject.h + * \ingroup bgeconv + */ + #ifndef BL_DEFORMABLEGAMEOBJECT #define BL_DEFORMABLEGAMEOBJECT diff --git a/source/gameengine/Converter/BL_MeshDeformer.h b/source/gameengine/Converter/BL_MeshDeformer.h index 48878d3f084..b62958c7fd1 100644 --- a/source/gameengine/Converter/BL_MeshDeformer.h +++ b/source/gameengine/Converter/BL_MeshDeformer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file BL_MeshDeformer.h + * \ingroup bgeconv + */ + #ifndef BL_MESHDEFORMER #define BL_MESHDEFORMER diff --git a/source/gameengine/Converter/BL_ModifierDeformer.h b/source/gameengine/Converter/BL_ModifierDeformer.h index caf1741ecaf..e9e546ebc86 100644 --- a/source/gameengine/Converter/BL_ModifierDeformer.h +++ b/source/gameengine/Converter/BL_ModifierDeformer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file BL_ModifierDeformer.h + * \ingroup bgeconv + */ + #ifndef BL_MODIFIERDEFORMER #define BL_MODIFIERDEFORMER diff --git a/source/gameengine/Converter/BL_ShapeActionActuator.h b/source/gameengine/Converter/BL_ShapeActionActuator.h index 64b75967874..229c59a34a4 100644 --- a/source/gameengine/Converter/BL_ShapeActionActuator.h +++ b/source/gameengine/Converter/BL_ShapeActionActuator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file BL_ShapeActionActuator.h + * \ingroup bgeconv + */ + #ifndef BL_SHAPEACTIONACTUATOR #define BL_SHAPEACTIONACTUATOR diff --git a/source/gameengine/Converter/BL_ShapeDeformer.h b/source/gameengine/Converter/BL_ShapeDeformer.h index b3b0996c27b..8115af59d27 100644 --- a/source/gameengine/Converter/BL_ShapeDeformer.h +++ b/source/gameengine/Converter/BL_ShapeDeformer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file BL_ShapeDeformer.h + * \ingroup bgeconv + */ + #ifndef BL_SHAPEDEFORMER #define BL_SHAPEDEFORMER diff --git a/source/gameengine/Converter/BL_SkinDeformer.h b/source/gameengine/Converter/BL_SkinDeformer.h index f8483519eb2..69b8783ce22 100644 --- a/source/gameengine/Converter/BL_SkinDeformer.h +++ b/source/gameengine/Converter/BL_SkinDeformer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file BL_SkinDeformer.h + * \ingroup bgeconv + */ + #ifndef BL_SKINDEFORMER #define BL_SKINDEFORMER diff --git a/source/gameengine/Converter/BlenderWorldInfo.h b/source/gameengine/Converter/BlenderWorldInfo.h index 29145344d18..e7b8784a076 100644 --- a/source/gameengine/Converter/BlenderWorldInfo.h +++ b/source/gameengine/Converter/BlenderWorldInfo.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file BlenderWorldInfo.h + * \ingroup bgeconv + */ + #ifndef __BLENDERWORLDINFO_H #define __BLENDERWORLDINFO_H #include "MT_CmMatrix4x4.h" diff --git a/source/gameengine/Converter/KX_BlenderScalarInterpolator.h b/source/gameengine/Converter/KX_BlenderScalarInterpolator.h index 7b49cbcf668..bd786bae969 100644 --- a/source/gameengine/Converter/KX_BlenderScalarInterpolator.h +++ b/source/gameengine/Converter/KX_BlenderScalarInterpolator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_BlenderScalarInterpolator.h + * \ingroup bgeconv + */ + #ifndef __KX_SCALARINTERPOLATOR_H #define __KX_SCALARINTERPOLATOR_H diff --git a/source/gameengine/Converter/KX_BlenderSceneConverter.h b/source/gameengine/Converter/KX_BlenderSceneConverter.h index 8692a75ecb6..f99ed3aa412 100644 --- a/source/gameengine/Converter/KX_BlenderSceneConverter.h +++ b/source/gameengine/Converter/KX_BlenderSceneConverter.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_BlenderSceneConverter.h + * \ingroup bgeconv + */ + #ifndef __KX_BLENDERSCENECONVERTER_H #define __KX_BLENDERSCENECONVERTER_H diff --git a/source/gameengine/Converter/KX_ConvertActuators.h b/source/gameengine/Converter/KX_ConvertActuators.h index 82624f94b49..90bb3f3fabd 100644 --- a/source/gameengine/Converter/KX_ConvertActuators.h +++ b/source/gameengine/Converter/KX_ConvertActuators.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ConvertActuators.h + * \ingroup bgeconv + */ + #ifndef __KX_CONVERTACTUATORS_H #define __KX_CONVERTACTUATORS_H diff --git a/source/gameengine/Converter/KX_ConvertControllers.h b/source/gameengine/Converter/KX_ConvertControllers.h index c251985abfb..c06c3825fd5 100644 --- a/source/gameengine/Converter/KX_ConvertControllers.h +++ b/source/gameengine/Converter/KX_ConvertControllers.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ConvertControllers.h + * \ingroup bgeconv + */ + #ifndef __KX_CONVERTCONTROLLERS_H #define __KX_CONVERTCONTROLLERS_H diff --git a/source/gameengine/Converter/KX_ConvertProperties.h b/source/gameengine/Converter/KX_ConvertProperties.h index 0fac2be0fe5..19c56fdc1d9 100644 --- a/source/gameengine/Converter/KX_ConvertProperties.h +++ b/source/gameengine/Converter/KX_ConvertProperties.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ConvertProperties.h + * \ingroup bgeconv + */ + #ifndef __KX_CONVERTPROPERTIES #define __KX_CONVERTPROPERTIES diff --git a/source/gameengine/Converter/KX_ConvertSensors.h b/source/gameengine/Converter/KX_ConvertSensors.h index db3c6146f18..75a58deedc8 100644 --- a/source/gameengine/Converter/KX_ConvertSensors.h +++ b/source/gameengine/Converter/KX_ConvertSensors.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ConvertSensors.h + * \ingroup bgeconv + */ + #ifndef __KX_CONVERTSENSOR_H #define __KX_CONVERTSENSOR_H diff --git a/source/gameengine/Converter/KX_IpoConvert.h b/source/gameengine/Converter/KX_IpoConvert.h index 6178f00efb5..d77a72a82e2 100644 --- a/source/gameengine/Converter/KX_IpoConvert.h +++ b/source/gameengine/Converter/KX_IpoConvert.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_IpoConvert.h + * \ingroup bgeconv + */ + #ifndef __KX_IPOCONVERT_H #define __KX_IPOCONVERT_H diff --git a/source/gameengine/Converter/KX_SoftBodyDeformer.h b/source/gameengine/Converter/KX_SoftBodyDeformer.h index 76874bdc782..aa4ff9d5e54 100644 --- a/source/gameengine/Converter/KX_SoftBodyDeformer.h +++ b/source/gameengine/Converter/KX_SoftBodyDeformer.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_SoftBodyDeformer.h + * \ingroup bgeconv + */ + #ifndef KX_SOFTBODYDEFORMER #define KX_SOFTBODYDEFORMER diff --git a/source/gameengine/Expressions/BoolValue.h b/source/gameengine/Expressions/BoolValue.h index 8110b9719bf..a88bcf98e77 100644 --- a/source/gameengine/Expressions/BoolValue.h +++ b/source/gameengine/Expressions/BoolValue.h @@ -12,6 +12,11 @@ * purpose. It is provided "as is" without express or implied warranty. * */ + +/** \file BoolValue.h + * \ingroup expressions + */ + #if !defined _BOOLVALUE_H #define _BOOLVALUE_H diff --git a/source/gameengine/Expressions/ConstExpr.h b/source/gameengine/Expressions/ConstExpr.h index aef2ddc2467..07278eb03f6 100644 --- a/source/gameengine/Expressions/ConstExpr.h +++ b/source/gameengine/Expressions/ConstExpr.h @@ -13,6 +13,10 @@ * */ +/** \file ConstExpr.h + * \ingroup expressions + */ + #ifndef __CONSTEXPR_H__ #define __CONSTEXPR_H__ diff --git a/source/gameengine/Expressions/EXP_C-Api.h b/source/gameengine/Expressions/EXP_C-Api.h index 12fdc4945e7..89156033be5 100644 --- a/source/gameengine/Expressions/EXP_C-Api.h +++ b/source/gameengine/Expressions/EXP_C-Api.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file EXP_C-Api.h + * \ingroup expressions + */ + #ifndef __EXPRESSION_INCLUDE #define __EXPRESSION_INCLUDE diff --git a/source/gameengine/Expressions/EmptyValue.h b/source/gameengine/Expressions/EmptyValue.h index f00bc6cfcd7..1b1c1159169 100644 --- a/source/gameengine/Expressions/EmptyValue.h +++ b/source/gameengine/Expressions/EmptyValue.h @@ -12,6 +12,11 @@ * purpose. It is provided "as is" without express or implied warranty. * */ + +/** \file EmptyValue.h + * \ingroup expressions + */ + #if !defined _EMPTYVALUE_H #define _EMPTYVALUE_H diff --git a/source/gameengine/Expressions/ErrorValue.h b/source/gameengine/Expressions/ErrorValue.h index 6bd131b762d..7f18e751af9 100644 --- a/source/gameengine/Expressions/ErrorValue.h +++ b/source/gameengine/Expressions/ErrorValue.h @@ -13,6 +13,10 @@ * */ +/** \file ErrorValue.h + * \ingroup expressions + */ + #if !defined _ERRORVALUE_H #define _ERRORVALUE_H diff --git a/source/gameengine/Expressions/Expression.h b/source/gameengine/Expressions/Expression.h index de0c0821727..c285fa118c1 100644 --- a/source/gameengine/Expressions/Expression.h +++ b/source/gameengine/Expressions/Expression.h @@ -13,6 +13,10 @@ * */ +/** \file Expression.h + * \ingroup expressions + */ + #if !defined _EXPRESSION_H #define _EXPRESSION_H diff --git a/source/gameengine/Expressions/FloatValue.h b/source/gameengine/Expressions/FloatValue.h index 83b9ff1db5e..535939e1758 100644 --- a/source/gameengine/Expressions/FloatValue.h +++ b/source/gameengine/Expressions/FloatValue.h @@ -12,6 +12,11 @@ * purpose. It is provided "as is" without express or implied warranty. * */ + +/** \file FloatValue.h + * \ingroup expressions + */ + #if !defined _FLOATVALUE_H #define _FLOATVALUE_H diff --git a/source/gameengine/Expressions/IdentifierExpr.h b/source/gameengine/Expressions/IdentifierExpr.h index 0e67b17a9c2..676b1b11607 100644 --- a/source/gameengine/Expressions/IdentifierExpr.h +++ b/source/gameengine/Expressions/IdentifierExpr.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file IdentifierExpr.h + * \ingroup expressions + */ + #ifndef __IDENTIFIER_EXPR #define __IDENTIFIER_EXPR diff --git a/source/gameengine/Expressions/IfExpr.h b/source/gameengine/Expressions/IfExpr.h index b2a953bd36d..5ac8d835afd 100644 --- a/source/gameengine/Expressions/IfExpr.h +++ b/source/gameengine/Expressions/IfExpr.h @@ -12,6 +12,11 @@ * purpose. It is provided "as is" without express or implied warranty. * */ + +/** \file IfExpr.h + * \ingroup expressions + */ + #if !defined(AFX_IFEXPR_H__1F691841_C5C7_11D1_A863_0000B4542BD8__INCLUDED_) #define AFX_IFEXPR_H__1F691841_C5C7_11D1_A863_0000B4542BD8__INCLUDED_ diff --git a/source/gameengine/Expressions/InputParser.h b/source/gameengine/Expressions/InputParser.h index 4c47677034b..d5a9295ab8b 100644 --- a/source/gameengine/Expressions/InputParser.h +++ b/source/gameengine/Expressions/InputParser.h @@ -14,6 +14,11 @@ * purpose. It is provided "as is" without express or implied warranty. * */ + +/** \file InputParser.h + * \ingroup expressions + */ + #ifndef __INPUTPARSER_H__ #define __INPUTPARSER_H__ diff --git a/source/gameengine/Expressions/IntValue.h b/source/gameengine/Expressions/IntValue.h index e484c436177..5460f744de3 100644 --- a/source/gameengine/Expressions/IntValue.h +++ b/source/gameengine/Expressions/IntValue.h @@ -12,6 +12,11 @@ * purpose. It is provided "as is" without express or implied warranty. * */ + +/** \file IntValue.h + * \ingroup expressions + */ + #if !defined _INTVALUE_H #define _INTVALUE_H diff --git a/source/gameengine/Expressions/KX_HashedPtr.h b/source/gameengine/Expressions/KX_HashedPtr.h index 09332377918..77e581360e7 100644 --- a/source/gameengine/Expressions/KX_HashedPtr.h +++ b/source/gameengine/Expressions/KX_HashedPtr.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_HashedPtr.h + * \ingroup expressions + */ + #ifndef __KX_HASHEDPTR #define __KX_HASHEDPTR diff --git a/source/gameengine/Expressions/KX_Python.h b/source/gameengine/Expressions/KX_Python.h index 234b70770f6..9d295e1910e 100644 --- a/source/gameengine/Expressions/KX_Python.h +++ b/source/gameengine/Expressions/KX_Python.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_Python.h + * \ingroup expressions + */ + #ifndef KX_PYTHON_H #define KX_PYTHON_H diff --git a/source/gameengine/Expressions/ListValue.h b/source/gameengine/Expressions/ListValue.h index ff675dd0e68..c1530d86d8c 100644 --- a/source/gameengine/Expressions/ListValue.h +++ b/source/gameengine/Expressions/ListValue.h @@ -13,6 +13,10 @@ * */ +/** \file ListValue.h + * \ingroup expressions + */ + #if !defined _LISTVALUE_H #define _LISTVALUE_H diff --git a/source/gameengine/Expressions/Operator1Expr.h b/source/gameengine/Expressions/Operator1Expr.h index 62f178fb9f7..c6fce709248 100644 --- a/source/gameengine/Expressions/Operator1Expr.h +++ b/source/gameengine/Expressions/Operator1Expr.h @@ -13,6 +13,10 @@ * */ +/** \file Operator1Expr.h + * \ingroup expressions + */ + #if !defined(AFX_OPERATOR1EXPR_H__A1653901_BF41_11D1_A51C_00A02472FC58__INCLUDED_) #define AFX_OPERATOR1EXPR_H__A1653901_BF41_11D1_A51C_00A02472FC58__INCLUDED_ diff --git a/source/gameengine/Expressions/Operator2Expr.h b/source/gameengine/Expressions/Operator2Expr.h index 73ea177f0d0..3b4d604c254 100644 --- a/source/gameengine/Expressions/Operator2Expr.h +++ b/source/gameengine/Expressions/Operator2Expr.h @@ -13,6 +13,10 @@ * */ +/** \file Operator2Expr.h + * \ingroup expressions + */ + #if !defined _OPERATOR2EXPR_H #define _OPERATOR2EXPR_H diff --git a/source/gameengine/Expressions/PyObjectPlus.h b/source/gameengine/Expressions/PyObjectPlus.h index 4890a5edb04..12ae31f6c82 100644 --- a/source/gameengine/Expressions/PyObjectPlus.h +++ b/source/gameengine/Expressions/PyObjectPlus.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file PyObjectPlus.h + * \ingroup expressions + */ + #ifndef _adr_py_lib_h_ // only process once, #define _adr_py_lib_h_ // even if multiply included diff --git a/source/gameengine/Expressions/StringValue.h b/source/gameengine/Expressions/StringValue.h index ef8228141a2..6afe7fa5935 100644 --- a/source/gameengine/Expressions/StringValue.h +++ b/source/gameengine/Expressions/StringValue.h @@ -13,6 +13,10 @@ * */ +/** \file StringValue.h + * \ingroup expressions + */ + #ifndef __STRINGVALUE_H__ #define __STRINGVALUE_H__ diff --git a/source/gameengine/Expressions/Value.h b/source/gameengine/Expressions/Value.h index b4bb34b0331..ef7edd397b7 100644 --- a/source/gameengine/Expressions/Value.h +++ b/source/gameengine/Expressions/Value.h @@ -13,29 +13,14 @@ * */ +/** \file Value.h + * \ingroup expressions + */ + #if defined(WIN32) && !defined(FREE_WINDOWS) #pragma warning (disable:4786) #endif //WIN32 -///////////////////////////////////////////////////////////////////////////////////// -//// Baseclass CValue -//// Together with CExpression, CValue and it's derived classes can be used to -//// parse expressions into a parsetree with error detecting/correcting capabilities -//// also expandible by a CFactory pluginsystem -//// -//// Features: -//// Reference Counting (AddRef() / Release()) -//// Calculations (Calc() / CalcFinal()) -//// Configuration (Configure()) -//// Serialization (EdSerialize() / EdIdSerialize() / EdPtrSerialize() and macro PLUGIN_DECLARE_SERIAL -//// Property system (SetProperty() / GetProperty() / FindIdentifier()) -//// Replication (GetReplica()) -//// Flags (IsSelected() / IsModified() / SetSelected()...) -//// -//// Some small editor-specific things added -//// A helperclass CompressorArchive handles the serialization -//// -///////////////////////////////////////////////////////////////////////////////////// #ifndef __VALUE_H__ #define __VALUE_H__ @@ -184,21 +169,35 @@ public: #endif }; -// -// CValue -// -// Base class for all editor functionality, flexible object type that allows -// calculations and uses reference counting for memory management. -// -// - - - #include "PyObjectPlus.h" #ifdef WITH_PYTHON #include "object.h" #endif + +/** + * Baseclass CValue + * + * Together with CExpression, CValue and it's derived classes can be used to + * parse expressions into a parsetree with error detecting/correcting capabilities + * also expandible by a CFactory pluginsystem + * + * Base class for all editor functionality, flexible object type that allows + * calculations and uses reference counting for memory management. + * + * Features: + * - Reference Counting (AddRef() / Release()) + * - Calculations (Calc() / CalcFinal()) + * - Configuration (Configure()) + * - Serialization (EdSerialize() / EdIdSerialize() / EdPtrSerialize() and macro PLUGIN_DECLARE_SERIAL + * - Property system (SetProperty() / GetProperty() / FindIdentifier()) + * - Replication (GetReplica()) + * - Flags (IsSelected() / IsModified() / SetSelected()...) + * + * - Some small editor-specific things added + * - A helperclass CompressorArchive handles the serialization + * + */ class CValue : public PyObjectPlus { diff --git a/source/gameengine/Expressions/VectorValue.h b/source/gameengine/Expressions/VectorValue.h index cc4deda2041..94d1ae65ada 100644 --- a/source/gameengine/Expressions/VectorValue.h +++ b/source/gameengine/Expressions/VectorValue.h @@ -12,6 +12,11 @@ * purpose. It is provided "as is" without express or implied warranty. * */ + +/** \file VectorValue.h + * \ingroup expressions + */ + #if !defined _VECTORVALUE_H #define _VECTORVALUE_H diff --git a/source/gameengine/Expressions/VoidValue.h b/source/gameengine/Expressions/VoidValue.h index f30f8c1be7c..2e5c056d793 100644 --- a/source/gameengine/Expressions/VoidValue.h +++ b/source/gameengine/Expressions/VoidValue.h @@ -1,4 +1,4 @@ -/** +/* * VoidValue.h: interface for the CVoidValue class. * $Id$ * @@ -27,6 +27,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file VoidValue.h + * \ingroup expressions + */ + #ifndef __VOIDVALUE_H__ #define __VOIDVALUE_H__ diff --git a/source/gameengine/GameLogic/Joystick/SCA_Joystick.h b/source/gameengine/GameLogic/Joystick/SCA_Joystick.h index b6e54dc2fcd..f371955ffc6 100644 --- a/source/gameengine/GameLogic/Joystick/SCA_Joystick.h +++ b/source/gameengine/GameLogic/Joystick/SCA_Joystick.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 SCA_Joystick.h + * \ingroup gamelogic + */ + #ifndef _SCA_JOYSTICK_H_ #define _SCA_JOYSTICK_H_ @@ -33,7 +37,7 @@ #include "SDL.h" #endif -/* +/** * Basic Joystick class * I will make this class a singleton because there should be only one joystick * even if there are more than one scene using it and count how many scene are using it. @@ -53,22 +57,22 @@ class SCA_Joystick #endif int m_joyindex; - /* + /** *support for JOYAXIS_MAX axes (in pairs) */ int m_axis_array[JOYAXIS_MAX]; - /* + /** *support for JOYHAT_MAX hats (each is a direction) */ int m_hat_array[JOYHAT_MAX]; - /* + /** * Precision or range of the axes */ int m_prec; - /* + /** * max # of buttons avail */ @@ -76,17 +80,17 @@ class SCA_Joystick int m_buttonmax; int m_hatmax; - /* is the joystick initialized ?*/ + /** is the joystick initialized ?*/ bool m_isinit; - /* is triggered for each event type */ + /** is triggered for each event type */ bool m_istrig_axis; bool m_istrig_button; bool m_istrig_hat; #ifndef DISABLE_SDL - /* + /** * event callbacks */ void OnAxisMotion(SDL_Event *sdl_event); @@ -99,27 +103,27 @@ class SCA_Joystick #endif #endif - /* + /** * Open the joystick */ bool CreateJoystickDevice(void); - /* + /** * Close the joystick */ void DestroyJoystickDevice(void); - /* + /** * fills the axis mnember values */ void pFillButtons(void); - /* + /** * returns m_axis_array */ int pAxisTest(int axisnum); - /* + /** * returns m_axis_array */ int pGetAxis(int axisnum, int udlr); @@ -146,7 +150,7 @@ public: bool aButtonReleaseIsPositive(int button); bool aHatIsPositive(int hatnum, int dir); - /* + /** * precision is default '3200' which is overridden by input */ @@ -176,7 +180,7 @@ public: return m_istrig_hat; } - /* + /** * returns the # of... */ @@ -184,7 +188,7 @@ public: int GetNumberOfButtons(void); int GetNumberOfHats(void); - /* + /** * Test if the joystick is connected */ int Connected(void); diff --git a/source/gameengine/GameLogic/Joystick/SCA_JoystickDefines.h b/source/gameengine/GameLogic/Joystick/SCA_JoystickDefines.h index 4b66535de43..69fc393cbd7 100644 --- a/source/gameengine/GameLogic/Joystick/SCA_JoystickDefines.h +++ b/source/gameengine/GameLogic/Joystick/SCA_JoystickDefines.h @@ -1,4 +1,4 @@ -/** +/* * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -24,6 +24,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_JoystickDefines.h + * \ingroup gamelogic + */ + #ifndef _SCA_JOYSTICKDEFINES_H_ #define _SCA_JOYSTICKDEFINES_H_ diff --git a/source/gameengine/GameLogic/Joystick/SCA_JoystickPrivate.h b/source/gameengine/GameLogic/Joystick/SCA_JoystickPrivate.h index 4e7f6f73413..02dd8145bb7 100644 --- a/source/gameengine/GameLogic/Joystick/SCA_JoystickPrivate.h +++ b/source/gameengine/GameLogic/Joystick/SCA_JoystickPrivate.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 SCA_JoystickPrivate.h + * \ingroup gamelogic + */ + #ifndef __SCA_JOYSTICKPRIVATE_H__ #define __SCA_JOYSTICKPRIVATE_H__ #include "SCA_Joystick.h" diff --git a/source/gameengine/GameLogic/SCA_2DFilterActuator.h b/source/gameengine/GameLogic/SCA_2DFilterActuator.h index 034b10763ce..87d2e8ddbcf 100644 --- a/source/gameengine/GameLogic/SCA_2DFilterActuator.h +++ b/source/gameengine/GameLogic/SCA_2DFilterActuator.h @@ -1,4 +1,4 @@ -/** +/* * SCA_2DFilterActuator.h * * $Id$ @@ -25,6 +25,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_2DFilterActuator.h + * \ingroup gamelogic + */ + #ifndef __SCA_2DFILETRACTUATOR_H__ #define __SCA_2DFILETRACTUATOR_H__ diff --git a/source/gameengine/GameLogic/SCA_ANDController.h b/source/gameengine/GameLogic/SCA_ANDController.h index a511a438c2f..728dc121f80 100644 --- a/source/gameengine/GameLogic/SCA_ANDController.h +++ b/source/gameengine/GameLogic/SCA_ANDController.h @@ -1,4 +1,4 @@ -/** +/* * SCA_ANDController.h * * $Id$ @@ -29,6 +29,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_ANDController.h + * \ingroup gamelogic + */ + #ifndef __KX_ANDCONTROLLER #define __KX_ANDCONTROLLER diff --git a/source/gameengine/GameLogic/SCA_ActuatorEventManager.h b/source/gameengine/GameLogic/SCA_ActuatorEventManager.h index 859cc5023f1..8530c944c49 100644 --- a/source/gameengine/GameLogic/SCA_ActuatorEventManager.h +++ b/source/gameengine/GameLogic/SCA_ActuatorEventManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_ActuatorEventManager.h + * \ingroup gamelogic + */ + #ifndef __KX_ACTUATOREVENTMANAGER #define __KX_ACTUATOREVENTMANAGER diff --git a/source/gameengine/GameLogic/SCA_ActuatorSensor.h b/source/gameengine/GameLogic/SCA_ActuatorSensor.h index eb52d365079..cb3e2e05125 100644 --- a/source/gameengine/GameLogic/SCA_ActuatorSensor.h +++ b/source/gameengine/GameLogic/SCA_ActuatorSensor.h @@ -1,4 +1,4 @@ -/** +/* * Actuator sensor * * $Id$ @@ -29,6 +29,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_ActuatorSensor.h + * \ingroup gamelogic + */ + #ifndef __KX_ACTUATORSENSOR #define __KX_ACTUATORSENSOR diff --git a/source/gameengine/GameLogic/SCA_AlwaysEventManager.h b/source/gameengine/GameLogic/SCA_AlwaysEventManager.h index 59429303fc4..4e05c7cf60c 100644 --- a/source/gameengine/GameLogic/SCA_AlwaysEventManager.h +++ b/source/gameengine/GameLogic/SCA_AlwaysEventManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_AlwaysEventManager.h + * \ingroup gamelogic + */ + #ifndef __KX_ALWAYSEVENTMGR #define __KX_ALWAYSEVENTMGR #include "SCA_EventManager.h" diff --git a/source/gameengine/GameLogic/SCA_AlwaysSensor.h b/source/gameengine/GameLogic/SCA_AlwaysSensor.h index 0de2a3f0629..9e4d120d1bd 100644 --- a/source/gameengine/GameLogic/SCA_AlwaysSensor.h +++ b/source/gameengine/GameLogic/SCA_AlwaysSensor.h @@ -1,4 +1,4 @@ -/** +/* * SCA_AlwaysSensor.h * * $Id$ @@ -29,6 +29,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_AlwaysSensor.h + * \ingroup gamelogic + */ + #ifndef __KX_ALWAYSSENSOR #define __KX_ALWAYSSENSOR #include "SCA_ISensor.h" diff --git a/source/gameengine/GameLogic/SCA_BasicEventManager.h b/source/gameengine/GameLogic/SCA_BasicEventManager.h index db67b180fd8..8c6741859bf 100644 --- a/source/gameengine/GameLogic/SCA_BasicEventManager.h +++ b/source/gameengine/GameLogic/SCA_BasicEventManager.h @@ -1,4 +1,4 @@ -/** +/* * Manager for sensor that only need to call Update * * $Id$ @@ -29,6 +29,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_BasicEventManager.h + * \ingroup gamelogic + */ + #ifndef __SCA_BASICEVENTMGR #define __SCA_BASICEVENTMGR diff --git a/source/gameengine/GameLogic/SCA_DelaySensor.h b/source/gameengine/GameLogic/SCA_DelaySensor.h index c5db16afb54..f690caca50b 100644 --- a/source/gameengine/GameLogic/SCA_DelaySensor.h +++ b/source/gameengine/GameLogic/SCA_DelaySensor.h @@ -1,4 +1,4 @@ -/** +/* * SCA_DelaySensor.h * * $Id$ @@ -29,6 +29,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_DelaySensor.h + * \ingroup gamelogic + */ + #ifndef __KX_DELAYSENSOR #define __KX_DELAYSENSOR #include "SCA_ISensor.h" diff --git a/source/gameengine/GameLogic/SCA_EventManager.h b/source/gameengine/GameLogic/SCA_EventManager.h index b01d3641cdb..88a750d346c 100644 --- a/source/gameengine/GameLogic/SCA_EventManager.h +++ b/source/gameengine/GameLogic/SCA_EventManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_EventManager.h + * \ingroup gamelogic + */ + #ifndef __KX_EVENTMANAGER #define __KX_EVENTMANAGER diff --git a/source/gameengine/GameLogic/SCA_ExpressionController.h b/source/gameengine/GameLogic/SCA_ExpressionController.h index 38e3904a8d6..2c3005c4c2d 100644 --- a/source/gameengine/GameLogic/SCA_ExpressionController.h +++ b/source/gameengine/GameLogic/SCA_ExpressionController.h @@ -1,4 +1,4 @@ -/** +/* * KX_EXPRESSIONController.h * * $Id$ @@ -29,6 +29,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_ExpressionController.h + * \ingroup gamelogic + */ + #ifndef __KX_EXPRESSIONCONTROLLER #define __KX_EXPRESSIONCONTROLLER diff --git a/source/gameengine/GameLogic/SCA_IActuator.h b/source/gameengine/GameLogic/SCA_IActuator.h index d3ead7c7460..bfcec983e2a 100644 --- a/source/gameengine/GameLogic/SCA_IActuator.h +++ b/source/gameengine/GameLogic/SCA_IActuator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,13 +26,18 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_IActuator.h + * \ingroup gamelogic + */ + #ifndef __KX_IACTUATOR #define __KX_IACTUATOR #include "SCA_IController.h" #include <vector> -/* +/** * Use of SG_DList : None * Use of SG_QList : element of activated actuator list of their owner * Head: SCA_IObject::m_activeActuators diff --git a/source/gameengine/GameLogic/SCA_IController.h b/source/gameengine/GameLogic/SCA_IController.h index 2d19770be4a..541d69c6f3b 100644 --- a/source/gameengine/GameLogic/SCA_IController.h +++ b/source/gameengine/GameLogic/SCA_IController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,13 +26,18 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_IController.h + * \ingroup gamelogic + */ + #ifndef __KX_ICONTROLLER #define __KX_ICONTROLLER #include "SCA_ILogicBrick.h" #include "PyObjectPlus.h" -/* +/** * Use of SG_DList element: none * Use of SG_QList element: build ordered list of activated controller on the owner object * Head: SCA_IObject::m_activeControllers diff --git a/source/gameengine/GameLogic/SCA_IInputDevice.h b/source/gameengine/GameLogic/SCA_IInputDevice.h index 0dbfe424e2c..49d52d0befc 100644 --- a/source/gameengine/GameLogic/SCA_IInputDevice.h +++ b/source/gameengine/GameLogic/SCA_IInputDevice.h @@ -1,7 +1,4 @@ -/** - * Interface for input devices. The defines for keyboard/system/mouse events - * here are for internal use in the KX module. - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +27,13 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_IController.h + * \ingroup gamelogic + * \brief Interface for input devices. The defines for keyboard/system/mouse events + * here are for internal use in the KX module. + * + */ + #ifndef KX_INPUTDEVICE_H #define KX_INPUTDEVICE_H diff --git a/source/gameengine/GameLogic/SCA_ILogicBrick.h b/source/gameengine/GameLogic/SCA_ILogicBrick.h index a444210e8d9..e74cd601b6b 100644 --- a/source/gameengine/GameLogic/SCA_ILogicBrick.h +++ b/source/gameengine/GameLogic/SCA_ILogicBrick.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_ILogicBrick.h + * \ingroup gamelogic + */ + #ifndef __KX_ILOGICBRICK #define __KX_ILOGICBRICK diff --git a/source/gameengine/GameLogic/SCA_IObject.h b/source/gameengine/GameLogic/SCA_IObject.h index 591be6fe53b..8ff7dcc4ad5 100644 --- a/source/gameengine/GameLogic/SCA_IObject.h +++ b/source/gameengine/GameLogic/SCA_IObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,9 +25,12 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * An abstract object that has some logic, python scripting and - * reference counting Note: transformation stuff has been moved to - * SceneGraph + */ +/** \file SCA_IController.h + * \ingroup gamelogic + * \brief An abstract object that has some logic, python scripting and + * reference counting Note: transformation stuff has been moved to + * SceneGraph */ #ifndef SCA_IOBJECT_H diff --git a/source/gameengine/GameLogic/SCA_IScene.h b/source/gameengine/GameLogic/SCA_IScene.h index 93b040c9a31..a441a512550 100644 --- a/source/gameengine/GameLogic/SCA_IScene.h +++ b/source/gameengine/GameLogic/SCA_IScene.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_IScene.h + * \ingroup gamelogic + */ + #ifndef __KX_ISCENE_H #define __KX_ISCENE_H diff --git a/source/gameengine/GameLogic/SCA_ISensor.h b/source/gameengine/GameLogic/SCA_ISensor.h index f31dd83343b..741448b1096 100644 --- a/source/gameengine/GameLogic/SCA_ISensor.h +++ b/source/gameengine/GameLogic/SCA_ISensor.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,8 +25,12 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Interface Class for all logic Sensors. Implements - * pulsemode and pulsefrequency, and event suppression. + */ + +/** \file SCA_IController.h + * \ingroup gamelogic + * \brief Interface Class for all logic Sensors. Implements + * pulsemode and pulsefrequency, and event suppression. */ #ifndef __SCA_ISENSOR diff --git a/source/gameengine/GameLogic/SCA_JoystickManager.h b/source/gameengine/GameLogic/SCA_JoystickManager.h index e5f53442049..dc778f231af 100644 --- a/source/gameengine/GameLogic/SCA_JoystickManager.h +++ b/source/gameengine/GameLogic/SCA_JoystickManager.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 SCA_JoystickManager.h + * \ingroup gamelogic + */ + #ifndef __JOYSTICKMANAGER_H_ #define __JOYSTICKMANAGER_H_ diff --git a/source/gameengine/GameLogic/SCA_JoystickSensor.h b/source/gameengine/GameLogic/SCA_JoystickSensor.h index 39f826dfe02..b4ed2c06d2f 100644 --- a/source/gameengine/GameLogic/SCA_JoystickSensor.h +++ b/source/gameengine/GameLogic/SCA_JoystickSensor.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 SCA_JoystickSensor.h + * \ingroup gamelogic + */ + #ifndef __JOYSENSOR_H_ #define __JOYSENSOR_H diff --git a/source/gameengine/GameLogic/SCA_KeyboardManager.h b/source/gameengine/GameLogic/SCA_KeyboardManager.h index 53735f9fae1..a74636d4582 100644 --- a/source/gameengine/GameLogic/SCA_KeyboardManager.h +++ b/source/gameengine/GameLogic/SCA_KeyboardManager.h @@ -1,6 +1,4 @@ -/** - * Manager for keyboard events - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,12 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_KeyboardManager.h + * \ingroup gamelogic + * \brief Manager for keyboard events + * + */ + #ifndef __KX_KEYBOARDMANAGER #define __KX_KEYBOARDMANAGER diff --git a/source/gameengine/GameLogic/SCA_KeyboardSensor.h b/source/gameengine/GameLogic/SCA_KeyboardSensor.h index 0a3b25ac361..ee40567fce2 100644 --- a/source/gameengine/GameLogic/SCA_KeyboardSensor.h +++ b/source/gameengine/GameLogic/SCA_KeyboardSensor.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Sensor for keyboard input + */ + +/** \file SCA_KeyboardSensor.h + * \ingroup gamelogic + * \brief Sensor for keyboard input */ #ifndef __KX_KEYBOARDSENSOR diff --git a/source/gameengine/GameLogic/SCA_LogicManager.h b/source/gameengine/GameLogic/SCA_LogicManager.h index f92b27f641a..44dc12a8fd4 100644 --- a/source/gameengine/GameLogic/SCA_LogicManager.h +++ b/source/gameengine/GameLogic/SCA_LogicManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,10 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Regulates the top-level logic behaviour for one scene. + */ +/** \file SCA_IController.h + * \ingroup gamelogic + * \brief Regulates the top-level logic behaviour for one scene. */ #ifndef __KX_LOGICMANAGER #define __KX_LOGICMANAGER diff --git a/source/gameengine/GameLogic/SCA_MouseManager.h b/source/gameengine/GameLogic/SCA_MouseManager.h index 8bf060537ca..737da049c2e 100644 --- a/source/gameengine/GameLogic/SCA_MouseManager.h +++ b/source/gameengine/GameLogic/SCA_MouseManager.h @@ -1,6 +1,4 @@ -/** - * Manager for mouse events - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,12 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_MouseManager.h + * \ingroup gamelogic + * \brief Manager for mouse events. + * + */ + #ifndef __KX_MOUSEMANAGER #define __KX_MOUSEMANAGER diff --git a/source/gameengine/GameLogic/SCA_MouseSensor.h b/source/gameengine/GameLogic/SCA_MouseSensor.h index dc0e9a11d39..7b83812a669 100644 --- a/source/gameengine/GameLogic/SCA_MouseSensor.h +++ b/source/gameengine/GameLogic/SCA_MouseSensor.h @@ -1,6 +1,4 @@ -/** - * Senses mouse events - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_MouseSensor.h + * \ingroup gamelogic + * \brief Senses mouse events + */ + #ifndef __KX_MOUSESENSOR #define __KX_MOUSESENSOR diff --git a/source/gameengine/GameLogic/SCA_NANDController.h b/source/gameengine/GameLogic/SCA_NANDController.h index b1ec7de13dd..4353c653046 100644 --- a/source/gameengine/GameLogic/SCA_NANDController.h +++ b/source/gameengine/GameLogic/SCA_NANDController.h @@ -1,6 +1,4 @@ -/** - * SCA_NANDController.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_NANDController.h + * \ingroup gamelogic + */ + #ifndef __KX_NANDCONTROLLER #define __KX_NANDCONTROLLER diff --git a/source/gameengine/GameLogic/SCA_NORController.h b/source/gameengine/GameLogic/SCA_NORController.h index 12b2ad99282..5bb3b346e56 100644 --- a/source/gameengine/GameLogic/SCA_NORController.h +++ b/source/gameengine/GameLogic/SCA_NORController.h @@ -1,6 +1,4 @@ -/** - * SCA_NORController.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_NORController.h + * \ingroup gamelogic + */ + #ifndef __KX_NORCONTROLLER #define __KX_NORCONTROLLER diff --git a/source/gameengine/GameLogic/SCA_ORController.h b/source/gameengine/GameLogic/SCA_ORController.h index eb848c6d9e3..6baaa50f43d 100644 --- a/source/gameengine/GameLogic/SCA_ORController.h +++ b/source/gameengine/GameLogic/SCA_ORController.h @@ -1,6 +1,4 @@ -/** - * SCA_ORController.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_ORController.h + * \ingroup gamelogic + */ + #ifndef __KX_ORCONTROLLER #define __KX_ORCONTROLLER diff --git a/source/gameengine/GameLogic/SCA_PropertyActuator.h b/source/gameengine/GameLogic/SCA_PropertyActuator.h index a38c42f16ad..1ca7b1c4e1e 100644 --- a/source/gameengine/GameLogic/SCA_PropertyActuator.h +++ b/source/gameengine/GameLogic/SCA_PropertyActuator.h @@ -1,6 +1,4 @@ -/** - * SCA_PropertyActuator.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_PropertyActuator.h + * \ingroup gamelogic + */ + #ifndef __KX_PROPERTYACTUATOR #define __KX_PROPERTYACTUATOR diff --git a/source/gameengine/GameLogic/SCA_PropertyEventManager.h b/source/gameengine/GameLogic/SCA_PropertyEventManager.h index 4e2920d9d70..b928a082a41 100644 --- a/source/gameengine/GameLogic/SCA_PropertyEventManager.h +++ b/source/gameengine/GameLogic/SCA_PropertyEventManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_PropertyEventManager.h + * \ingroup gamelogic + */ + #ifndef __KX_PROPERTYEVENTMANAGER #define __KX_PROPERTYEVENTMANAGER diff --git a/source/gameengine/GameLogic/SCA_PropertySensor.h b/source/gameengine/GameLogic/SCA_PropertySensor.h index 5a29c526fc0..a0dee4da5ee 100644 --- a/source/gameengine/GameLogic/SCA_PropertySensor.h +++ b/source/gameengine/GameLogic/SCA_PropertySensor.h @@ -1,6 +1,4 @@ -/** - * Property sensor - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_PropertySensor.h + * \ingroup gamelogic + * \brief Property sensor + */ + #ifndef __KX_PROPERTYSENSOR #define __KX_PROPERTYSENSOR diff --git a/source/gameengine/GameLogic/SCA_PythonController.h b/source/gameengine/GameLogic/SCA_PythonController.h index 602b5e27e47..3ccbfea7ed5 100644 --- a/source/gameengine/GameLogic/SCA_PythonController.h +++ b/source/gameengine/GameLogic/SCA_PythonController.h @@ -1,6 +1,4 @@ -/** - * Execute Python scripts - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_PythonController.h + * \ingroup gamelogic + * \brief Execute Python scripts + */ + #ifndef KX_PYTHONCONTROLLER_H #define KX_PYTHONCONTROLLER_H diff --git a/source/gameengine/GameLogic/SCA_PythonKeyboard.h b/source/gameengine/GameLogic/SCA_PythonKeyboard.h index 6a89ba7de76..98bde606a47 100644 --- a/source/gameengine/GameLogic/SCA_PythonKeyboard.h +++ b/source/gameengine/GameLogic/SCA_PythonKeyboard.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -22,6 +22,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_PythonKeyboard.h + * \ingroup gamelogic + */ + #ifndef __KX_PYKEYBOARD #define __KX_PYKEYBOARD diff --git a/source/gameengine/GameLogic/SCA_PythonMouse.h b/source/gameengine/GameLogic/SCA_PythonMouse.h index 15a7e19c602..30a30b5d924 100644 --- a/source/gameengine/GameLogic/SCA_PythonMouse.h +++ b/source/gameengine/GameLogic/SCA_PythonMouse.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -22,6 +22,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_PythonMouse.h + * \ingroup gamelogic + */ + #ifndef __KX_PYMOUSE #define __KX_PYMOUSE diff --git a/source/gameengine/GameLogic/SCA_RandomActuator.h b/source/gameengine/GameLogic/SCA_RandomActuator.h index 1fd2180f32c..d28586b267e 100644 --- a/source/gameengine/GameLogic/SCA_RandomActuator.h +++ b/source/gameengine/GameLogic/SCA_RandomActuator.h @@ -1,7 +1,4 @@ -/** - * Draw a random number, and put it in a property - * - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_RandomActuator.h + * \ingroup gamelogic + * \brief Draw a random number, and put it in a property + */ + #ifndef __KX_RANDOMACTUATOR #define __KX_RANDOMACTUATOR diff --git a/source/gameengine/GameLogic/SCA_RandomEventManager.h b/source/gameengine/GameLogic/SCA_RandomEventManager.h index 51d233c4321..686cc225eac 100644 --- a/source/gameengine/GameLogic/SCA_RandomEventManager.h +++ b/source/gameengine/GameLogic/SCA_RandomEventManager.h @@ -1,6 +1,4 @@ -/** - * Manager for random events - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_RandomEventManager.h + * \ingroup gamelogic + * \brief Manager for random events + */ + #ifndef __KX_RANDOMEVENTMGR #define __KX_RANDOMEVENTMGR diff --git a/source/gameengine/GameLogic/SCA_RandomNumberGenerator.h b/source/gameengine/GameLogic/SCA_RandomNumberGenerator.h index 8402d0312fc..0cfd8302ca2 100644 --- a/source/gameengine/GameLogic/SCA_RandomNumberGenerator.h +++ b/source/gameengine/GameLogic/SCA_RandomNumberGenerator.h @@ -1,8 +1,4 @@ -/** - * Generate random numbers that can be used by other components. Each - * generator needs its own generator, so that the seed can be set - * on a per-generator basis. - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -31,6 +27,13 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_RandomNumberGenerator.h + * \ingroup gamelogic + * \brief Generate random numbers that can be used by other components. Each + * generator needs its own generator, so that the seed can be set + * on a per-generator basis. + */ + #ifndef __KX_RANDOMNUMBERGENERATOR #define __KX_RANDOMNUMBERGENERATOR diff --git a/source/gameengine/GameLogic/SCA_RandomSensor.h b/source/gameengine/GameLogic/SCA_RandomSensor.h index af5a767c1c1..d559e17810b 100644 --- a/source/gameengine/GameLogic/SCA_RandomSensor.h +++ b/source/gameengine/GameLogic/SCA_RandomSensor.h @@ -1,6 +1,4 @@ -/** - * Generate random pulses - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_RandomSensor.h + * \ingroup gamelogic + * \brief Generate random pulses + */ + #ifndef __KX_RANDOMSENSOR #define __KX_RANDOMSENSOR diff --git a/source/gameengine/GameLogic/SCA_TimeEventManager.h b/source/gameengine/GameLogic/SCA_TimeEventManager.h index a3aa994ea37..43eacfe16fa 100644 --- a/source/gameengine/GameLogic/SCA_TimeEventManager.h +++ b/source/gameengine/GameLogic/SCA_TimeEventManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SCA_TimeEventManager.h + * \ingroup gamelogic + */ + #ifndef __KX_TIMEEVENTMANAGER #define __KX_TIMEEVENTMANAGER diff --git a/source/gameengine/GameLogic/SCA_XNORController.h b/source/gameengine/GameLogic/SCA_XNORController.h index 54361be163a..5696585a0fc 100644 --- a/source/gameengine/GameLogic/SCA_XNORController.h +++ b/source/gameengine/GameLogic/SCA_XNORController.h @@ -1,6 +1,4 @@ -/** - * SCA_XNORController.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_XNORController.h + * \ingroup gamelogic + */ + #ifndef __KX_XNORCONTROLLER #define __KX_XNORCONTROLLER diff --git a/source/gameengine/GameLogic/SCA_XORController.h b/source/gameengine/GameLogic/SCA_XORController.h index 940e3d2135c..84f7120546f 100644 --- a/source/gameengine/GameLogic/SCA_XORController.h +++ b/source/gameengine/GameLogic/SCA_XORController.h @@ -1,6 +1,4 @@ -/** - * SCA_XORController.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SCA_XORController.h + * \ingroup gamelogic + */ + #ifndef __KX_XORCONTROLLER #define __KX_XORCONTROLLER diff --git a/source/gameengine/GamePlayer/common/GPC_Canvas.h b/source/gameengine/GamePlayer/common/GPC_Canvas.h index 6e5d58c8478..87693696c2a 100644 --- a/source/gameengine/GamePlayer/common/GPC_Canvas.h +++ b/source/gameengine/GamePlayer/common/GPC_Canvas.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPC_Canvas.h + * \ingroup player + */ + #ifndef _GPC_CANVAS_H_ #define _GPC_CANVAS_H_ diff --git a/source/gameengine/GamePlayer/common/GPC_Engine.h b/source/gameengine/GamePlayer/common/GPC_Engine.h index 0b7c85396f2..cfa280c5385 100644 --- a/source/gameengine/GamePlayer/common/GPC_Engine.h +++ b/source/gameengine/GamePlayer/common/GPC_Engine.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPC_Engine.h + * \ingroup player + */ + #ifndef __GPC_ENGINE_H #define __GPC_ENGINE_H diff --git a/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h b/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h index 206d37f7be6..a35a55ddf03 100644 --- a/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h +++ b/source/gameengine/GamePlayer/common/GPC_KeyboardDevice.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPC_KeyboardDevice.h + * \ingroup player + */ + #ifndef __GPC_KEYBOARDDEVICE_H #define __GPC_KEYBOARDDEVICE_H diff --git a/source/gameengine/GamePlayer/common/GPC_MouseDevice.h b/source/gameengine/GamePlayer/common/GPC_MouseDevice.h index 41f34b8e22f..d35faa30d92 100644 --- a/source/gameengine/GamePlayer/common/GPC_MouseDevice.h +++ b/source/gameengine/GamePlayer/common/GPC_MouseDevice.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPC_MouseDevice.h + * \ingroup player + */ + #ifndef __GPC_MOUSE_DEVICE_H #define __GPC_MOUSE_DEVICE_H diff --git a/source/gameengine/GamePlayer/common/GPC_RawImage.h b/source/gameengine/GamePlayer/common/GPC_RawImage.h index b66567854dd..2db9c093e36 100644 --- a/source/gameengine/GamePlayer/common/GPC_RawImage.h +++ b/source/gameengine/GamePlayer/common/GPC_RawImage.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPC_RawImage.h + * \ingroup player + */ + #ifndef __GPC_RAWIMAGE_H__ #define __GPC_RAWIMAGE_H__ diff --git a/source/gameengine/GamePlayer/common/GPC_RawLoadDotBlendArray.h b/source/gameengine/GamePlayer/common/GPC_RawLoadDotBlendArray.h index 4a1ff4e43fa..0b07ab85f65 100644 --- a/source/gameengine/GamePlayer/common/GPC_RawLoadDotBlendArray.h +++ b/source/gameengine/GamePlayer/common/GPC_RawLoadDotBlendArray.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPC_RawLoadDotBlendArray.h + * \ingroup player + */ + #ifndef __GPC_RAWLOADDOTBLENDARRAY_H #define __GPC_RAWLOADDOTBLENDARRAY_H diff --git a/source/gameengine/GamePlayer/common/GPC_RawLogoArrays.h b/source/gameengine/GamePlayer/common/GPC_RawLogoArrays.h index 464b7bacec8..a1eb0a4861c 100644 --- a/source/gameengine/GamePlayer/common/GPC_RawLogoArrays.h +++ b/source/gameengine/GamePlayer/common/GPC_RawLogoArrays.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPC_RawLogoArrays.h + * \ingroup player + */ + #ifndef __GPC_RAWLOGOARRAYS_H #define __GPC_RAWLOGOARRAYS_H diff --git a/source/gameengine/GamePlayer/common/GPC_RenderTools.h b/source/gameengine/GamePlayer/common/GPC_RenderTools.h index 714d686439d..ee490dacddb 100644 --- a/source/gameengine/GamePlayer/common/GPC_RenderTools.h +++ b/source/gameengine/GamePlayer/common/GPC_RenderTools.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPC_RenderTools.h + * \ingroup player + */ + #ifndef __GPC_RENDERTOOLS_H #define __GPC_RENDERTOOLS_H diff --git a/source/gameengine/GamePlayer/common/GPC_System.h b/source/gameengine/GamePlayer/common/GPC_System.h index 65a488e08bd..51847827f10 100644 --- a/source/gameengine/GamePlayer/common/GPC_System.h +++ b/source/gameengine/GamePlayer/common/GPC_System.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPC_System.h + * \ingroup player + */ + #ifndef __GPC_SYSTEM_H #define __GPC_SYSTEM_H diff --git a/source/gameengine/GamePlayer/ghost/GPG_Application.h b/source/gameengine/GamePlayer/ghost/GPG_Application.h index 48a6c8e78ec..850b34d5b69 100644 --- a/source/gameengine/GamePlayer/ghost/GPG_Application.h +++ b/source/gameengine/GamePlayer/ghost/GPG_Application.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * GHOST Blender Player application declaration file. + */ + +/** \file GPG_Application.h + * \ingroup player + * \brief GHOST Blender Player application declaration file. */ #include "GHOST_IEventConsumer.h" diff --git a/source/gameengine/GamePlayer/ghost/GPG_Canvas.h b/source/gameengine/GamePlayer/ghost/GPG_Canvas.h index 7b19c03d3c3..e03f7d6740e 100644 --- a/source/gameengine/GamePlayer/ghost/GPG_Canvas.h +++ b/source/gameengine/GamePlayer/ghost/GPG_Canvas.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file GPG_Canvas.h + * \ingroup player + */ + #ifndef _GPG_CANVAS_H_ #define _GPG_CANVAS_H_ diff --git a/source/gameengine/GamePlayer/ghost/GPG_KeyboardDevice.h b/source/gameengine/GamePlayer/ghost/GPG_KeyboardDevice.h index 8fb42caed95..5471db42f3f 100644 --- a/source/gameengine/GamePlayer/ghost/GPG_KeyboardDevice.h +++ b/source/gameengine/GamePlayer/ghost/GPG_KeyboardDevice.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * GHOST Blender Player keyboard device. + */ + +/** \file GPG_KeyboardDevice.h + * \ingroup player + * \brief GHOST Blender Player keyboard device. */ #ifndef _GPG_KEYBOARDDEVICE_H_ diff --git a/source/gameengine/GamePlayer/ghost/GPG_System.h b/source/gameengine/GamePlayer/ghost/GPG_System.h index e6e5506cbc1..49a91b60415 100644 --- a/source/gameengine/GamePlayer/ghost/GPG_System.h +++ b/source/gameengine/GamePlayer/ghost/GPG_System.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Blender Player system on GHOST. + */ + +/** \file GPG_System.h + * \ingroup player + * \brief Blender Player system on GHOST. */ #ifndef _GPG_SYSTEM_H_ diff --git a/source/gameengine/Ketsji/BL_BlenderShader.h b/source/gameengine/Ketsji/BL_BlenderShader.h index c2d4245b77f..2f22e121b8c 100644 --- a/source/gameengine/Ketsji/BL_BlenderShader.h +++ b/source/gameengine/Ketsji/BL_BlenderShader.h @@ -1,3 +1,35 @@ +/* + * $Id$ + * + * ***** BEGIN GPL LICENSE BLOCK ***** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + * The Original Code is Copyright (C) Blender Foundation + * All rights reserved. + * + * The Original Code is: all of this file. + * + * Contributor(s): none yet. + * + * ***** END GPL LICENSE BLOCK ***** + */ + +/** \file BL_BlenderShader.h + * \ingroup ketsji + */ #ifndef __BL_GPUSHADER_H__ #define __BL_GPUSHADER_H__ diff --git a/source/gameengine/Ketsji/BL_Material.h b/source/gameengine/Ketsji/BL_Material.h index 62e5a6e638b..126135f3d46 100644 --- a/source/gameengine/Ketsji/BL_Material.h +++ b/source/gameengine/Ketsji/BL_Material.h @@ -1,3 +1,8 @@ + +/** \file BL_Material.h + * \ingroup ketsji + */ + #ifndef __BL_MATERIAL_H__ #define __BL_MATERIAL_H__ diff --git a/source/gameengine/Ketsji/BL_Shader.h b/source/gameengine/Ketsji/BL_Shader.h index 77c642ecc7b..41802a0a19f 100644 --- a/source/gameengine/Ketsji/BL_Shader.h +++ b/source/gameengine/Ketsji/BL_Shader.h @@ -1,3 +1,8 @@ + +/** \file BL_Shader.h + * \ingroup ketsji + */ + #ifndef __BL_SHADER_H__ #define __BL_SHADER_H__ diff --git a/source/gameengine/Ketsji/BL_Texture.h b/source/gameengine/Ketsji/BL_Texture.h index eb3888b4862..3c60cad4fbf 100644 --- a/source/gameengine/Ketsji/BL_Texture.h +++ b/source/gameengine/Ketsji/BL_Texture.h @@ -1,3 +1,8 @@ + +/** \file BL_Texture.h + * \ingroup ketsji + */ + #ifndef __BL_TEXTURE_H__ #define __BL_TEXTURE_H__ diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.h b/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.h index 80139c67fd3..ff9131f464e 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.h +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,8 +25,13 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Ketsji Logic Extenstion: Network Event Manager class */ + +/** \file KX_NetworkEventManager.h + * \ingroup ketsjinet + * \brief Ketsji Logic Extenstion: Network Event Manager class + */ + #ifndef KX_NETWORK_EVENTMANAGER_H #define KX_NETWORK_EVENTMANAGER_H diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.h b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.h index 62bcca19955..3cea20c56d2 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.h +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,8 +25,13 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Ketsji Logic Extenstion: Network Message Actuator class */ + +/** \file KX_NetworkMessageActuator.h + * \ingroup ketsjinet + * \brief Ketsji Logic Extenstion: Network Message Actuator class + */ + #ifndef __KX_NETWORKMESSAGEACTUATOR_H #define __KX_NETWORKMESSAGEACTUATOR_H diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.h b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.h index 8f5a11426a7..721e80195c3 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.h +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Ketsji Logic Extenstion: Network Message Sensor class + */ + +/** \file KX_NetworkMessageSensor.h + * \ingroup ketsjinet + * \brief Ketsji Logic Extenstion: Network Message Sensor class */ #ifndef __KX_NETWORKMESSAGE_SENSOR_H #define __KX_NETWORKMESSAGE_SENSOR_H diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkObjectActuator.h b/source/gameengine/Ketsji/KXNetwork/KX_NetworkObjectActuator.h index aca0805c337..7d7671eed69 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkObjectActuator.h +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkObjectActuator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkObjectSensor.h b/source/gameengine/Ketsji/KXNetwork/KX_NetworkObjectSensor.h index aca0805c337..7d7671eed69 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkObjectSensor.h +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkObjectSensor.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** diff --git a/source/gameengine/Ketsji/KX_ArmatureSensor.h b/source/gameengine/Ketsji/KX_ArmatureSensor.h index b007899c4ff..42e042e1401 100644 --- a/source/gameengine/Ketsji/KX_ArmatureSensor.h +++ b/source/gameengine/Ketsji/KX_ArmatureSensor.h @@ -1,6 +1,4 @@ -/** - * Property sensor - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_ArmatureSensor.h + * \ingroup ketsji + * \brief Property sensor + */ + #ifndef __KX_ARMATURESENSOR #define __KX_ARMATURESENSOR diff --git a/source/gameengine/Ketsji/KX_BlenderMaterial.h b/source/gameengine/Ketsji/KX_BlenderMaterial.h index 950a605c451..766e20be825 100644 --- a/source/gameengine/Ketsji/KX_BlenderMaterial.h +++ b/source/gameengine/Ketsji/KX_BlenderMaterial.h @@ -1,3 +1,8 @@ + +/** \file KX_BlenderMaterial.h + * \ingroup ketsji + */ + #ifndef __KX_BLENDER_MATERIAL_H__ #define __KX_BLENDER_MATERIAL_H__ diff --git a/source/gameengine/Ketsji/KX_BulletPhysicsController.h b/source/gameengine/Ketsji/KX_BulletPhysicsController.h index a3e8fafec1d..d46caca49f1 100644 --- a/source/gameengine/Ketsji/KX_BulletPhysicsController.h +++ b/source/gameengine/Ketsji/KX_BulletPhysicsController.h @@ -1,3 +1,8 @@ + +/** \file KX_BulletPhysicsController.h + * \ingroup ketsji + */ + #ifndef KX_BULLET2PHYSICS_CONTROLLER #define KX_BULLET2PHYSICS_CONTROLLER diff --git a/source/gameengine/Ketsji/KX_Camera.h b/source/gameengine/Ketsji/KX_Camera.h index 130dfd4067d..61a0e39e546 100644 --- a/source/gameengine/Ketsji/KX_Camera.h +++ b/source/gameengine/Ketsji/KX_Camera.h @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Camera in the gameengine. Cameras are also used for views. + */ + +/** \file KX_Camera.h + * \ingroup ketsji + * \brief Camera in the gameengine. Cameras are also used for views. */ #ifndef __KX_CAMERA diff --git a/source/gameengine/Ketsji/KX_CameraActuator.h b/source/gameengine/Ketsji/KX_CameraActuator.h index 0a0a47f1ce2..135a9cad9d8 100644 --- a/source/gameengine/Ketsji/KX_CameraActuator.h +++ b/source/gameengine/Ketsji/KX_CameraActuator.h @@ -1,4 +1,4 @@ -/** +/* * KX_CameraActuator.h * * $Id$ @@ -29,6 +29,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_CameraActuator.h + * \ingroup ketsji + */ + #ifndef __KX_CAMERAACTUATOR #define __KX_CAMERAACTUATOR diff --git a/source/gameengine/Ketsji/KX_CameraIpoSGController.h b/source/gameengine/Ketsji/KX_CameraIpoSGController.h index e6596edbd1d..967decfa7b0 100644 --- a/source/gameengine/Ketsji/KX_CameraIpoSGController.h +++ b/source/gameengine/Ketsji/KX_CameraIpoSGController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_CameraIpoSGController.h + * \ingroup ketsji + */ + #ifndef KX_CAMERAIPOSGCONTROLLER_H #define KX_CAMERAIPOSGCONTROLLER_H diff --git a/source/gameengine/Ketsji/KX_ClientObjectInfo.h b/source/gameengine/Ketsji/KX_ClientObjectInfo.h index c42843274b3..ae84cf2e300 100644 --- a/source/gameengine/Ketsji/KX_ClientObjectInfo.h +++ b/source/gameengine/Ketsji/KX_ClientObjectInfo.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ClientObjectInfo.h + * \ingroup ketsji + */ + #ifndef __KX_CLIENTOBJECT_INFO_H #define __KX_CLIENTOBJECT_INFO_H diff --git a/source/gameengine/Ketsji/KX_ConstraintActuator.h b/source/gameengine/Ketsji/KX_ConstraintActuator.h index 7bde2c1d3f7..d2eea1f7414 100644 --- a/source/gameengine/Ketsji/KX_ConstraintActuator.h +++ b/source/gameengine/Ketsji/KX_ConstraintActuator.h @@ -1,6 +1,4 @@ -/** - * KX_ConstraintActuator.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_ConstraintActuator.h + * \ingroup ketsji + */ + #ifndef __KX_CONSTRAINTACTUATOR #define __KX_CONSTRAINTACTUATOR diff --git a/source/gameengine/Ketsji/KX_ConstraintWrapper.h b/source/gameengine/Ketsji/KX_ConstraintWrapper.h index 58c204d5da0..1177586b95f 100644 --- a/source/gameengine/Ketsji/KX_ConstraintWrapper.h +++ b/source/gameengine/Ketsji/KX_ConstraintWrapper.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ConstraintWrapper.h + * \ingroup ketsji + */ + #ifndef KX_CONSTRAINT_WRAPPER #define KX_CONSTRAINT_WRAPPER diff --git a/source/gameengine/Ketsji/KX_ConvertPhysicsObject.h b/source/gameengine/Ketsji/KX_ConvertPhysicsObject.h index 2bb3534bde7..fa8c8d253e7 100644 --- a/source/gameengine/Ketsji/KX_ConvertPhysicsObject.h +++ b/source/gameengine/Ketsji/KX_ConvertPhysicsObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ConvertPhysicsObject.h + * \ingroup ketsji + */ + #ifndef KX_CONVERTPHYSICSOBJECTS #define KX_CONVERTPHYSICSOBJECTS diff --git a/source/gameengine/Ketsji/KX_Dome.h b/source/gameengine/Ketsji/KX_Dome.h index 749fbebe61c..844f40f0578 100644 --- a/source/gameengine/Ketsji/KX_Dome.h +++ b/source/gameengine/Ketsji/KX_Dome.h @@ -22,6 +22,10 @@ Developed as part of a Research and Development project for SAT - La Soci�t� ----------------------------------------------------------------------------- */ +/** \file KX_Dome.h + * \ingroup ketsji + */ + #if !defined KX_DOME_H #define KX_DOME_H diff --git a/source/gameengine/Ketsji/KX_EmptyObject.h b/source/gameengine/Ketsji/KX_EmptyObject.h index c41e40fdd41..e22e1aa7926 100644 --- a/source/gameengine/Ketsji/KX_EmptyObject.h +++ b/source/gameengine/Ketsji/KX_EmptyObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_EmptyObject.h + * \ingroup ketsji + */ + #ifndef __KX_EMPTYOBJECT #define __KX_EMPTYOBJECT #include "KX_GameObject.h" diff --git a/source/gameengine/Ketsji/KX_FontObject.h b/source/gameengine/Ketsji/KX_FontObject.h index a4f9692da57..c29ee4bcdcf 100644 --- a/source/gameengine/Ketsji/KX_FontObject.h +++ b/source/gameengine/Ketsji/KX_FontObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_FontObject.h + * \ingroup ketsji + */ + #ifndef __KX_FONTOBJECT #define __KX_FONTOBJECT #include "KX_GameObject.h" diff --git a/source/gameengine/Ketsji/KX_GameActuator.h b/source/gameengine/Ketsji/KX_GameActuator.h index 273d6664e1d..eee38b02406 100644 --- a/source/gameengine/Ketsji/KX_GameActuator.h +++ b/source/gameengine/Ketsji/KX_GameActuator.h @@ -1,7 +1,3 @@ - -// -// actuator for global game stuff -// // $Id$ // // ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +26,11 @@ // ***** END GPL LICENSE BLOCK ***** // +/** \file KX_GameActuator.h + * \ingroup ketsji + * \brief actuator for global game stuff + */ + #ifndef __KX_GAMEACTUATOR #define __KX_GAMEACTUATOR diff --git a/source/gameengine/Ketsji/KX_GameObject.h b/source/gameengine/Ketsji/KX_GameObject.h index 974dde6de00..b54fb6b068e 100644 --- a/source/gameengine/Ketsji/KX_GameObject.h +++ b/source/gameengine/Ketsji/KX_GameObject.h @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * General KX game object. + */ + +/** \file KX_GameObject.h + * \ingroup ketsji + * \brief General KX game object. */ #ifndef __KX_GAMEOBJECT diff --git a/source/gameengine/Ketsji/KX_IInterpolator.h b/source/gameengine/Ketsji/KX_IInterpolator.h index aadc964fe49..8eb62f84883 100644 --- a/source/gameengine/Ketsji/KX_IInterpolator.h +++ b/source/gameengine/Ketsji/KX_IInterpolator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_IInterpolator.h + * \ingroup ketsji + */ + #ifndef KX_IINTERPOLATOR_H #define KX_IINTERPOLATOR_H diff --git a/source/gameengine/Ketsji/KX_IPOTransform.h b/source/gameengine/Ketsji/KX_IPOTransform.h index ba2adfe2ef6..98eefa83e0d 100644 --- a/source/gameengine/Ketsji/KX_IPOTransform.h +++ b/source/gameengine/Ketsji/KX_IPOTransform.h @@ -1,6 +1,4 @@ -/** - * An abstract object you can move around in a 3d world, and has some logic - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_IPOTransform.h + * \ingroup ketsji + * \brief An abstract object you can move around in a 3d world, and has some logic + */ + #ifndef KX_IPOTRANSFORM_H #define KX_IPOTRANSFORM_H diff --git a/source/gameengine/Ketsji/KX_IPO_SGController.h b/source/gameengine/Ketsji/KX_IPO_SGController.h index 12803cde2f1..3d52eaea679 100644 --- a/source/gameengine/Ketsji/KX_IPO_SGController.h +++ b/source/gameengine/Ketsji/KX_IPO_SGController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_IPO_SGController.h + * \ingroup ketsji + */ + #ifndef __IPO_SGCONTROLLER_H #define __IPO_SGCONTROLLER_H diff --git a/source/gameengine/Ketsji/KX_IPhysicsController.h b/source/gameengine/Ketsji/KX_IPhysicsController.h index 288e779fee4..8bc28aa82b8 100644 --- a/source/gameengine/Ketsji/KX_IPhysicsController.h +++ b/source/gameengine/Ketsji/KX_IPhysicsController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_IPhysicsController.h + * \ingroup ketsji + */ + #ifndef __KX_IPHYSICSCONTROLLER_H #define __KX_IPHYSICSCONTROLLER_H diff --git a/source/gameengine/Ketsji/KX_IScalarInterpolator.h b/source/gameengine/Ketsji/KX_IScalarInterpolator.h index a84e1b570fd..46781557a01 100644 --- a/source/gameengine/Ketsji/KX_IScalarInterpolator.h +++ b/source/gameengine/Ketsji/KX_IScalarInterpolator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_IScalarInterpolator.h + * \ingroup ketsji + */ + #ifndef KX_ISCALARINTERPOLATOR_H #define KX_ISCALARINTERPOLATOR_H diff --git a/source/gameengine/Ketsji/KX_ISceneConverter.h b/source/gameengine/Ketsji/KX_ISceneConverter.h index 8a11b875347..7d85e69ecdd 100644 --- a/source/gameengine/Ketsji/KX_ISceneConverter.h +++ b/source/gameengine/Ketsji/KX_ISceneConverter.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ISceneConverter.h + * \ingroup ketsji + */ + #ifndef __KX_ISCENECONVERTER_H #define __KX_ISCENECONVERTER_H diff --git a/source/gameengine/Ketsji/KX_ISystem.h b/source/gameengine/Ketsji/KX_ISystem.h index fb019299135..da79bec51d5 100644 --- a/source/gameengine/Ketsji/KX_ISystem.h +++ b/source/gameengine/Ketsji/KX_ISystem.h @@ -1,6 +1,4 @@ -/** -* Abstract system -* +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_ISystem.h + * \ingroup ketsji + * \brief Abstract system + */ + #ifndef __KX_ISYSTEM #define __KX_ISYSTEM diff --git a/source/gameengine/Ketsji/KX_IpoActuator.h b/source/gameengine/Ketsji/KX_IpoActuator.h index 61e7f0451d1..56a60f48049 100644 --- a/source/gameengine/Ketsji/KX_IpoActuator.h +++ b/source/gameengine/Ketsji/KX_IpoActuator.h @@ -1,6 +1,4 @@ -/** - * Do an object ipo - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_IpoActuator.h + * \ingroup ketsji + * \brief Do an object ipo + */ + #ifndef __KX_IPOACTUATOR #define __KX_IPOACTUATOR diff --git a/source/gameengine/Ketsji/KX_KetsjiEngine.h b/source/gameengine/Ketsji/KX_KetsjiEngine.h index 8b07a998c33..8cd6fdb8f5f 100644 --- a/source/gameengine/Ketsji/KX_KetsjiEngine.h +++ b/source/gameengine/Ketsji/KX_KetsjiEngine.h @@ -27,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** * */ + +/** \file KX_KetsjiEngine.h + * \ingroup ketsji + */ + #ifndef __KX_KETSJI_ENGINE #define __KX_KETSJI_ENGINE diff --git a/source/gameengine/Ketsji/KX_Light.h b/source/gameengine/Ketsji/KX_Light.h index f7b40d24293..08e4e9da2e5 100644 --- a/source/gameengine/Ketsji/KX_Light.h +++ b/source/gameengine/Ketsji/KX_Light.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_Light.h + * \ingroup ketsji + */ + #ifndef __KX_LIGHT #define __KX_LIGHT diff --git a/source/gameengine/Ketsji/KX_LightIpoSGController.h b/source/gameengine/Ketsji/KX_LightIpoSGController.h index c857994d145..8271343907c 100644 --- a/source/gameengine/Ketsji/KX_LightIpoSGController.h +++ b/source/gameengine/Ketsji/KX_LightIpoSGController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_LightIpoSGController.h + * \ingroup ketsji + */ + #ifndef KX_LIGHTIPOSGCONTROLLER_H #define KX_LIGHTIPOSGCONTROLLER_H diff --git a/source/gameengine/Ketsji/KX_MaterialIpoController.h b/source/gameengine/Ketsji/KX_MaterialIpoController.h index a979f59ec95..85b2a971fbe 100644 --- a/source/gameengine/Ketsji/KX_MaterialIpoController.h +++ b/source/gameengine/Ketsji/KX_MaterialIpoController.h @@ -1,3 +1,8 @@ + +/** \file KX_MaterialIpoController.h + * \ingroup ketsji + */ + #ifndef __KX_MATERIALIPOCONTROLLER_H__ #define __KX_MATERIALIPOCONTROLLER_H__ diff --git a/source/gameengine/Ketsji/KX_MeshProxy.h b/source/gameengine/Ketsji/KX_MeshProxy.h index 29231498163..7074c120988 100644 --- a/source/gameengine/Ketsji/KX_MeshProxy.h +++ b/source/gameengine/Ketsji/KX_MeshProxy.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_MeshProxy.h + * \ingroup ketsji + */ + #ifndef __KX_MESHPROXY #define __KX_MESHPROXY diff --git a/source/gameengine/Ketsji/KX_MotionState.h b/source/gameengine/Ketsji/KX_MotionState.h index 1267abc7fa9..ec6469e4672 100644 --- a/source/gameengine/Ketsji/KX_MotionState.h +++ b/source/gameengine/Ketsji/KX_MotionState.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_MotionState.h + * \ingroup ketsji + */ + #ifndef __KX_MOTIONSTATE #define __KX_MOTIONSTATE diff --git a/source/gameengine/Ketsji/KX_MouseFocusSensor.h b/source/gameengine/Ketsji/KX_MouseFocusSensor.h index 3ea0f932314..73c5d94e4a5 100644 --- a/source/gameengine/Ketsji/KX_MouseFocusSensor.h +++ b/source/gameengine/Ketsji/KX_MouseFocusSensor.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * KX_MouseFocusSensor determines mouse in/out/over events. + */ + +/** \file KX_MouseFocusSensor.h + * \ingroup ketsji + * \brief KX_MouseFocusSensor determines mouse in/out/over events. */ #ifndef __KX_MOUSEFOCUSSENSOR diff --git a/source/gameengine/Ketsji/KX_NearSensor.h b/source/gameengine/Ketsji/KX_NearSensor.h index 67f235ceae2..d3de44429ff 100644 --- a/source/gameengine/Ketsji/KX_NearSensor.h +++ b/source/gameengine/Ketsji/KX_NearSensor.h @@ -1,6 +1,4 @@ -/** - * Sense if other objects are near - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_NearSensor.h + * \ingroup ketsji + * \brief Sense if other objects are near + */ + #ifndef KX_NEARSENSOR_H #define KX_NEARSENSOR_H diff --git a/source/gameengine/Ketsji/KX_ObColorIpoSGController.h b/source/gameengine/Ketsji/KX_ObColorIpoSGController.h index 4bb18fb392b..67bf561bd22 100644 --- a/source/gameengine/Ketsji/KX_ObColorIpoSGController.h +++ b/source/gameengine/Ketsji/KX_ObColorIpoSGController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ObColorIpoSGController.h + * \ingroup ketsji + */ + #ifndef KX_OBCOLORIPOSGCONTROLLER_H #define KX_OBCOLORIPOSGCONTROLLER_H diff --git a/source/gameengine/Ketsji/KX_ObjectActuator.h b/source/gameengine/Ketsji/KX_ObjectActuator.h index 9dab1e39cba..e45ce899bfc 100644 --- a/source/gameengine/Ketsji/KX_ObjectActuator.h +++ b/source/gameengine/Ketsji/KX_ObjectActuator.h @@ -1,6 +1,4 @@ -/** - * Do translation/rotation actions - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_ObjectActuator.h + * \ingroup ketsji + * \brief Do translation/rotation actions + */ + #ifndef __KX_OBJECTACTUATOR #define __KX_OBJECTACTUATOR diff --git a/source/gameengine/Ketsji/KX_OrientationInterpolator.h b/source/gameengine/Ketsji/KX_OrientationInterpolator.h index de41323c289..2ae7b00cb86 100644 --- a/source/gameengine/Ketsji/KX_OrientationInterpolator.h +++ b/source/gameengine/Ketsji/KX_OrientationInterpolator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_OrientationInterpolator.h + * \ingroup ketsji + */ + #ifndef KX_ORIENTATIONINTERPOLATOR #define KX_ORIENTATIONINTERPOLATOR diff --git a/source/gameengine/Ketsji/KX_ParentActuator.h b/source/gameengine/Ketsji/KX_ParentActuator.h index 28745c6d0f5..8723f83920e 100644 --- a/source/gameengine/Ketsji/KX_ParentActuator.h +++ b/source/gameengine/Ketsji/KX_ParentActuator.h @@ -1,7 +1,4 @@ -/** - * Set or remove an objects parent - * - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -33,6 +30,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_ParentActuator.h + * \ingroup ketsji + * \brief Set or remove an objects parent + */ + #ifndef __KX_PARENTACTUATOR #define __KX_PARENTACTUATOR diff --git a/source/gameengine/Ketsji/KX_PhysicsEngineEnums.h b/source/gameengine/Ketsji/KX_PhysicsEngineEnums.h index 506ba6365a0..6a9e40e187a 100644 --- a/source/gameengine/Ketsji/KX_PhysicsEngineEnums.h +++ b/source/gameengine/Ketsji/KX_PhysicsEngineEnums.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_PhysicsEngineEnums.h + * \ingroup ketsji + */ + #ifndef __KX_PHYSICSENGINEENUMS #define __KX_PHYSICSENGINEENUMS diff --git a/source/gameengine/Ketsji/KX_PhysicsObjectWrapper.h b/source/gameengine/Ketsji/KX_PhysicsObjectWrapper.h index ca7e99350c4..739d6b38ea1 100644 --- a/source/gameengine/Ketsji/KX_PhysicsObjectWrapper.h +++ b/source/gameengine/Ketsji/KX_PhysicsObjectWrapper.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_PhysicsObjectWrapper.h + * \ingroup ketsji + */ + #ifndef PHYP_PHYSICSOBJECT_WRAPPER #define PHYP_PHYSICSOBJECT_WRAPPER diff --git a/source/gameengine/Ketsji/KX_PhysicsPropertiesobsolete.h b/source/gameengine/Ketsji/KX_PhysicsPropertiesobsolete.h index d94b5328488..4cbd1f8b3b2 100644 --- a/source/gameengine/Ketsji/KX_PhysicsPropertiesobsolete.h +++ b/source/gameengine/Ketsji/KX_PhysicsPropertiesobsolete.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,12 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_PhysicsPropertiesobsolete.h + * \ingroup ketsji + * \todo check if this file is still needed + */ + #ifndef KX_PROPSH #define KX_PROPSH diff --git a/source/gameengine/Ketsji/KX_PolyProxy.h b/source/gameengine/Ketsji/KX_PolyProxy.h index 179fb67f85f..c99ac20673c 100644 --- a/source/gameengine/Ketsji/KX_PolyProxy.h +++ b/source/gameengine/Ketsji/KX_PolyProxy.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_PolyProxy.h + * \ingroup ketsji + */ + #ifndef __KX_POLYROXY #define __KX_POLYPROXY diff --git a/source/gameengine/Ketsji/KX_PolygonMaterial.h b/source/gameengine/Ketsji/KX_PolygonMaterial.h index d71a34989a0..3520995def3 100644 --- a/source/gameengine/Ketsji/KX_PolygonMaterial.h +++ b/source/gameengine/Ketsji/KX_PolygonMaterial.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_PolygonMaterial.h + * \ingroup ketsji + */ + #ifndef __KX_POLYGONMATERIAL_H__ #define __KX_POLYGONMATERIAL_H__ diff --git a/source/gameengine/Ketsji/KX_PositionInterpolator.h b/source/gameengine/Ketsji/KX_PositionInterpolator.h index 764c7bd8750..e053770e57e 100644 --- a/source/gameengine/Ketsji/KX_PositionInterpolator.h +++ b/source/gameengine/Ketsji/KX_PositionInterpolator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_PositionInterpolator.h + * \ingroup ketsji + */ + #ifndef KX_POSITIONINTERPOLATOR #define KX_POSITIONINTERPOLATOR diff --git a/source/gameengine/Ketsji/KX_PyConstraintBinding.h b/source/gameengine/Ketsji/KX_PyConstraintBinding.h index 6da60794eb0..9fbdf037caa 100644 --- a/source/gameengine/Ketsji/KX_PyConstraintBinding.h +++ b/source/gameengine/Ketsji/KX_PyConstraintBinding.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_PyConstraintBinding.h + * \ingroup ketsji + */ + #ifndef PHY_PYTHON_CONSTRAINTBINDING #define PHY_PYTHON_CONSTRAINTBINDING diff --git a/source/gameengine/Ketsji/KX_PyMath.h b/source/gameengine/Ketsji/KX_PyMath.h index 282e9a8f1f6..d7ea63c9880 100644 --- a/source/gameengine/Ketsji/KX_PyMath.h +++ b/source/gameengine/Ketsji/KX_PyMath.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Initialize Python thingies. + */ + +/** \file KX_PyMath.h + * \ingroup ketsji + * \brief Initialize Python thingies. */ #ifndef __KX_PYMATH_H__ diff --git a/source/gameengine/Ketsji/KX_PythonInit.h b/source/gameengine/Ketsji/KX_PythonInit.h index 7b0ed08c6bb..f062aa2d661 100644 --- a/source/gameengine/Ketsji/KX_PythonInit.h +++ b/source/gameengine/Ketsji/KX_PythonInit.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_PythonInit.h + * \ingroup ketsji + */ + #ifndef __KX_PYTHON_INIT #define __KX_PYTHON_INIT diff --git a/source/gameengine/Ketsji/KX_PythonInitTypes.h b/source/gameengine/Ketsji/KX_PythonInitTypes.h index 1053f320e5e..b113c080f4a 100644 --- a/source/gameengine/Ketsji/KX_PythonInitTypes.h +++ b/source/gameengine/Ketsji/KX_PythonInitTypes.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_PythonInitTypes.h + * \ingroup ketsji + */ + #ifndef _adr_py_init_types_h_ // only process once, #define _adr_py_init_types_h_ // even if multiply included diff --git a/source/gameengine/Ketsji/KX_PythonSeq.h b/source/gameengine/Ketsji/KX_PythonSeq.h index 7ca36cc19f4..7146e775a84 100644 --- a/source/gameengine/Ketsji/KX_PythonSeq.h +++ b/source/gameengine/Ketsji/KX_PythonSeq.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): Campbell Barton * * ***** END GPL LICENSE BLOCK ***** - * Readonly sequence wrapper for lookups on logic bricks + */ + +/** \file KX_PythonSeq.h + * \ingroup ketsji + * \brief Readonly sequence wrapper for lookups on logic bricks */ #ifndef _adr_py_seq_h_ // only process once, diff --git a/source/gameengine/Ketsji/KX_RadarSensor.h b/source/gameengine/Ketsji/KX_RadarSensor.h index 17305922385..6caff2758e7 100644 --- a/source/gameengine/Ketsji/KX_RadarSensor.h +++ b/source/gameengine/Ketsji/KX_RadarSensor.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_RadarSensor.h + * \ingroup ketsji + */ + #ifndef __KX_RADAR_SENSOR_H #define __KX_RADAR_SENSOR_H diff --git a/source/gameengine/Ketsji/KX_RayCast.h b/source/gameengine/Ketsji/KX_RayCast.h index 1512d81e940..963467c5958 100644 --- a/source/gameengine/Ketsji/KX_RayCast.h +++ b/source/gameengine/Ketsji/KX_RayCast.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_RayCast.h + * \ingroup ketsji + */ + #ifndef __KX_RAYCAST_H__ #define __KX_RAYCAST_H__ diff --git a/source/gameengine/Ketsji/KX_RayEventManager.h b/source/gameengine/Ketsji/KX_RayEventManager.h index 55c2b81b068..92ce836b950 100644 --- a/source/gameengine/Ketsji/KX_RayEventManager.h +++ b/source/gameengine/Ketsji/KX_RayEventManager.h @@ -1,6 +1,4 @@ -/** - * Manager for ray events - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_RayEventManager.h + * \ingroup ketsji + * \brief Manager for ray events + */ + #ifndef __KX_RAYEVENTMGR #define __KX_RAYEVENTMGR #include "SCA_EventManager.h" diff --git a/source/gameengine/Ketsji/KX_RaySensor.h b/source/gameengine/Ketsji/KX_RaySensor.h index ac0b5eba26b..ef8340e9f80 100644 --- a/source/gameengine/Ketsji/KX_RaySensor.h +++ b/source/gameengine/Ketsji/KX_RaySensor.h @@ -1,6 +1,4 @@ -/** - * Cast a ray and feel for objects - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_RaySensor.h + * \ingroup ketsji + * \brief Cast a ray and feel for objects + */ + #ifndef __KX_RAYSENSOR_H #define __KX_RAYSENSOR_H diff --git a/source/gameengine/Ketsji/KX_SCA_AddObjectActuator.h b/source/gameengine/Ketsji/KX_SCA_AddObjectActuator.h index 16612f9a743..11f210ad7b5 100644 --- a/source/gameengine/Ketsji/KX_SCA_AddObjectActuator.h +++ b/source/gameengine/Ketsji/KX_SCA_AddObjectActuator.h @@ -1,8 +1,3 @@ -// -// Add object to the game world on action of this actuator. A copy is made -// of a referenced object. The copy inherits some properties from the owner -// of this actuator. -// // $Id$ // // ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,10 +24,12 @@ // Contributor(s): none yet. // // ***** END GPL LICENSE BLOCK ***** -// -// Previously existed as: -// \source\gameengine\GameLogic\SCA_AddObjectActuator.h -// Please look here for revision history. + +/** \file KX_SCA_AddObjectActuator.h + * \ingroup ketsji + * \attention Previously existed as: \source\gameengine\GameLogic\SCA_AddObjectActuator.h + * Please look here for revision history. + */ #ifndef __KX_SCA_AddObjectActuator #define __KX_SCA_AddObjectActuator diff --git a/source/gameengine/Ketsji/KX_SCA_DynamicActuator.h b/source/gameengine/Ketsji/KX_SCA_DynamicActuator.h index 43322fdfd96..04b2c00f4c1 100644 --- a/source/gameengine/Ketsji/KX_SCA_DynamicActuator.h +++ b/source/gameengine/Ketsji/KX_SCA_DynamicActuator.h @@ -1,6 +1,3 @@ -// -// Add object to the game world on action of this actuator -// // $Id$ // // ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +26,11 @@ // ***** END GPL LICENSE BLOCK ***** // +/** \file KX_SCA_DynamicActuator.h + * \ingroup ketsji + * \brief Add object to the game world on action of this actuator + */ + #ifndef __KX_SCA_DYNAMICACTUATOR #define __KX_SCA_DYNAMICACTUATOR diff --git a/source/gameengine/Ketsji/KX_SCA_EndObjectActuator.h b/source/gameengine/Ketsji/KX_SCA_EndObjectActuator.h index cedf17c599b..c8e1af86466 100644 --- a/source/gameengine/Ketsji/KX_SCA_EndObjectActuator.h +++ b/source/gameengine/Ketsji/KX_SCA_EndObjectActuator.h @@ -1,6 +1,3 @@ -// -// Add object to the game world on action of this actuator -// // $Id$ // // ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,9 +25,13 @@ // // ***** END GPL LICENSE BLOCK ***** // -// Previously existed as: -// \source\gameengine\GameLogic\SCA_EndObjectActuator.h -// Please look here for revision history. + +/** \file KX_SCA_EndObjectActuator.h + * \ingroup ketsji + * \brief Add object to the game world on action of this actuator + * \attention Previously existed as: \source\gameengine\GameLogic\SCA_EndObjectActuator.h + * Please look here for revision history. + */ #ifndef __KX_SCA_ENDOBJECTACTUATOR #define __KX_SCA_ENDOBJECTACTUATOR diff --git a/source/gameengine/Ketsji/KX_SCA_ReplaceMeshActuator.h b/source/gameengine/Ketsji/KX_SCA_ReplaceMeshActuator.h index 573ec76782c..7838cb63b17 100644 --- a/source/gameengine/Ketsji/KX_SCA_ReplaceMeshActuator.h +++ b/source/gameengine/Ketsji/KX_SCA_ReplaceMeshActuator.h @@ -1,6 +1,3 @@ -// -// Add object to the game world on action of this actuator -// // $Id$ // // ***** BEGIN GPL LICENSE BLOCK ***** @@ -28,10 +25,13 @@ // // ***** END GPL LICENSE BLOCK ***** // -// Previously existed as: -// \source\gameengine\GameLogic\SCA_ReplaceMeshActuator.h -// Please look here for revision history. -// + +/** \file KX_SCA_ReplaceMeshActuator.h + * \ingroup ketsji + * \brief Add object to the game world on action of this actuator + * \attention Previously existed as: \source\gameengine\GameLogic\SCA_ReplaceMeshActuator.h + * Please look here for revision history. + */ #ifndef __KX_SCA_REPLACEMESHACTUATOR #define __KX_SCA_REPLACEMESHACTUATOR diff --git a/source/gameengine/Ketsji/KX_SG_BoneParentNodeRelationship.h b/source/gameengine/Ketsji/KX_SG_BoneParentNodeRelationship.h index 05e9d9f02de..6e6c197517f 100644 --- a/source/gameengine/Ketsji/KX_SG_BoneParentNodeRelationship.h +++ b/source/gameengine/Ketsji/KX_SG_BoneParentNodeRelationship.h @@ -1,19 +1,4 @@ -/** - * @mainpage KX_SG_NodeRelationships - - * @section - * - * This file provides common concrete implementations of - * SG_ParentRelation used by the game engine. These are - * KX_SlowParentRelation a slow parent relationship. - * KX_NormalParentRelation a normal parent relationship where - * orientation and position are inherited from the parent by - * the child. - * KX_VertexParentRelation only location information is - * inherited by the child. - * - * interface - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -43,6 +28,10 @@ * */ +/** \file KX_SG_BoneParentNodeRelationship.h + * \ingroup ketsji + */ + #ifndef __KX_SG_BONEPARENTRELATION_H__ #define __KX_SG_BONEPARENTRELATION_H__ diff --git a/source/gameengine/Ketsji/KX_SG_NodeRelationships.h b/source/gameengine/Ketsji/KX_SG_NodeRelationships.h index 7bb6f767308..3e18ddf2611 100644 --- a/source/gameengine/Ketsji/KX_SG_NodeRelationships.h +++ b/source/gameengine/Ketsji/KX_SG_NodeRelationships.h @@ -1,19 +1,4 @@ -/** - * @mainpage KX_SG_NodeRelationships - - * @section - * - * This file provides common concrete implementations of - * SG_ParentRelation used by the game engine. These are - * KX_SlowParentRelation a slow parent relationship. - * KX_NormalParentRelation a normal parent relationship where - * orientation and position are inherited from the parent by - * the child. - * KX_VertexParentRelation only location information is - * inherited by the child. - * - * interface - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -43,6 +28,19 @@ * */ +/** \file KX_SG_NodeRelationships.h + * \ingroup ketsji + * \section KX_SG_NodeRelationships + * This file provides common concrete implementations of + * SG_ParentRelation used by the game engine. These are + * KX_SlowParentRelation a slow parent relationship. + * KX_NormalParentRelation a normal parent relationship where + * orientation and position are inherited from the parent by + * the child. + * KX_VertexParentRelation only location information is + * inherited by the child. + */ + #ifndef __KX_SG_NODERELATIONS_H__ #define __KX_SG_NODERELATIONS_H__ diff --git a/source/gameengine/Ketsji/KX_ScalarInterpolator.h b/source/gameengine/Ketsji/KX_ScalarInterpolator.h index 5b66ad42bd9..1abc4f4f06f 100644 --- a/source/gameengine/Ketsji/KX_ScalarInterpolator.h +++ b/source/gameengine/Ketsji/KX_ScalarInterpolator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ScalarInterpolator.h + * \ingroup ketsji + */ + #ifndef KX_SCALARINTERPOLATOR #define KX_SCALARINTERPOLATOR diff --git a/source/gameengine/Ketsji/KX_ScalingInterpolator.h b/source/gameengine/Ketsji/KX_ScalingInterpolator.h index 87b85a30d1f..72b91c1a421 100644 --- a/source/gameengine/Ketsji/KX_ScalingInterpolator.h +++ b/source/gameengine/Ketsji/KX_ScalingInterpolator.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_ScalingInterpolator.h + * \ingroup ketsji + */ + #ifndef KX_SCALINGINTERPOLATOR #define KX_SCALINGINTERPOLATOR diff --git a/source/gameengine/Ketsji/KX_Scene.h b/source/gameengine/Ketsji/KX_Scene.h index 6bef3f95dde..af6a31e786c 100644 --- a/source/gameengine/Ketsji/KX_Scene.h +++ b/source/gameengine/Ketsji/KX_Scene.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_Scene.h + * \ingroup ketsji + */ + #ifndef __KX_SCENE_H #define __KX_SCENE_H diff --git a/source/gameengine/Ketsji/KX_SceneActuator.h b/source/gameengine/Ketsji/KX_SceneActuator.h index b49357b21ca..563255d1560 100644 --- a/source/gameengine/Ketsji/KX_SceneActuator.h +++ b/source/gameengine/Ketsji/KX_SceneActuator.h @@ -1,7 +1,3 @@ - -// -// Add object to the game world on action of this actuator -// // $Id$ // // ***** BEGIN GPL LICENSE BLOCK ***** @@ -30,6 +26,10 @@ // ***** END GPL LICENSE BLOCK ***** // +/** \file KX_SceneActuator.h + * \ingroup ketsji + */ + #ifndef __KX_SCENEACTUATOR #define __KX_SCENEACTUATOR diff --git a/source/gameengine/Ketsji/KX_SoundActuator.h b/source/gameengine/Ketsji/KX_SoundActuator.h index 7c1108ea8fb..e7257245a80 100644 --- a/source/gameengine/Ketsji/KX_SoundActuator.h +++ b/source/gameengine/Ketsji/KX_SoundActuator.h @@ -1,6 +1,4 @@ -/** - * KX_SoundActuator.h - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_SoundActuator.h + * \ingroup ketsji + */ + #ifndef __KX_SOUNDACTUATOR #define __KX_SOUNDACTUATOR diff --git a/source/gameengine/Ketsji/KX_StateActuator.h b/source/gameengine/Ketsji/KX_StateActuator.h index 3af03f5d1fb..bdaaa0ffbc2 100644 --- a/source/gameengine/Ketsji/KX_StateActuator.h +++ b/source/gameengine/Ketsji/KX_StateActuator.h @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Actuator to toggle visibility/invisibility of objects + */ + +/** \file KX_StateActuator.h + * \ingroup ketsji + * \brief Actuator to toggle visibility/invisibility of objects */ #ifndef __KX_STATEACTUATOR diff --git a/source/gameengine/Ketsji/KX_TimeCategoryLogger.h b/source/gameengine/Ketsji/KX_TimeCategoryLogger.h index f4eb4d18ab3..95358e99cb7 100644 --- a/source/gameengine/Ketsji/KX_TimeCategoryLogger.h +++ b/source/gameengine/Ketsji/KX_TimeCategoryLogger.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_TimeCategoryLogger.h + * \ingroup ketsji + */ + #ifndef __KX_TIME_CATEGORY_LOGGER_H #define __KX_TIME_CATEGORY_LOGGER_H diff --git a/source/gameengine/Ketsji/KX_TimeLogger.h b/source/gameengine/Ketsji/KX_TimeLogger.h index 9a5c124a462..a43c0bfddc7 100644 --- a/source/gameengine/Ketsji/KX_TimeLogger.h +++ b/source/gameengine/Ketsji/KX_TimeLogger.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_TimeLogger.h + * \ingroup ketsji + */ + #ifndef __KX_TIME_LOGGER_H #define __KX_TIME_LOGGER_H diff --git a/source/gameengine/Ketsji/KX_TouchEventManager.h b/source/gameengine/Ketsji/KX_TouchEventManager.h index 388195367b9..c8b86e854ae 100644 --- a/source/gameengine/Ketsji/KX_TouchEventManager.h +++ b/source/gameengine/Ketsji/KX_TouchEventManager.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_TouchEventManager.h + * \ingroup ketsji + */ + #ifndef __KX_TOUCHEVENTMANAGER #define __KX_TOUCHEVENTMANAGER diff --git a/source/gameengine/Ketsji/KX_TouchSensor.h b/source/gameengine/Ketsji/KX_TouchSensor.h index 80e5a0f938e..39011345267 100644 --- a/source/gameengine/Ketsji/KX_TouchSensor.h +++ b/source/gameengine/Ketsji/KX_TouchSensor.h @@ -1,6 +1,4 @@ -/** - * Senses touch and collision events - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +27,11 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file KX_TouchSensor.h + * \ingroup ketsji + * \brief Senses touch and collision events + */ + #ifndef __KX_TOUCHSENSOR #define __KX_TOUCHSENSOR diff --git a/source/gameengine/Ketsji/KX_TrackToActuator.h b/source/gameengine/Ketsji/KX_TrackToActuator.h index 33b2ecb1aa5..33780bf53e4 100644 --- a/source/gameengine/Ketsji/KX_TrackToActuator.h +++ b/source/gameengine/Ketsji/KX_TrackToActuator.h @@ -1,6 +1,3 @@ -// -// Add object to the game world on action of this actuator -// // $Id$ // // ***** BEGIN GPL LICENSE BLOCK ***** @@ -29,6 +26,10 @@ // ***** END GPL LICENSE BLOCK ***** // +/** \file KX_TrackToActuator.h + * \ingroup ketsji + */ + #ifndef __KX_TrackToActuator #define __KX_TrackToActuator diff --git a/source/gameengine/Ketsji/KX_VehicleWrapper.h b/source/gameengine/Ketsji/KX_VehicleWrapper.h index 4cde50b0932..f750912c95b 100644 --- a/source/gameengine/Ketsji/KX_VehicleWrapper.h +++ b/source/gameengine/Ketsji/KX_VehicleWrapper.h @@ -1,3 +1,8 @@ + +/** \file KX_VehicleWrapper.h + * \ingroup ketsji + */ + #ifndef KX_VEHICLE_WRAPPER #define KX_VEHICLE_WRAPPER diff --git a/source/gameengine/Ketsji/KX_VertexProxy.h b/source/gameengine/Ketsji/KX_VertexProxy.h index a5f2e5a08e0..e34330ebefe 100644 --- a/source/gameengine/Ketsji/KX_VertexProxy.h +++ b/source/gameengine/Ketsji/KX_VertexProxy.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_VertexProxy.h + * \ingroup ketsji + */ + #ifndef __KX_VERTEXPROXY #define __KX_VERTEXPROXY diff --git a/source/gameengine/Ketsji/KX_VisibilityActuator.h b/source/gameengine/Ketsji/KX_VisibilityActuator.h index 4969dda1158..9b40aec4506 100644 --- a/source/gameengine/Ketsji/KX_VisibilityActuator.h +++ b/source/gameengine/Ketsji/KX_VisibilityActuator.h @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Actuator to toggle visibility/invisibility of objects + */ + +/** \file KX_VisibilityActuator.h + * \ingroup ketsji + * \brief Actuator to toggle visibility/invisibility of objects */ #ifndef __KX_VISIBILITYACTUATOR diff --git a/source/gameengine/Ketsji/KX_WorldInfo.h b/source/gameengine/Ketsji/KX_WorldInfo.h index fb730c5502f..35e1d50af12 100644 --- a/source/gameengine/Ketsji/KX_WorldInfo.h +++ b/source/gameengine/Ketsji/KX_WorldInfo.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_WorldInfo.h + * \ingroup ketsji + */ + #ifndef __KX_WORLDINFO_H #define __KX_WORLDINFO_H diff --git a/source/gameengine/Ketsji/KX_WorldIpoController.h b/source/gameengine/Ketsji/KX_WorldIpoController.h index f6c36198ae7..bd87286bb41 100644 --- a/source/gameengine/Ketsji/KX_WorldIpoController.h +++ b/source/gameengine/Ketsji/KX_WorldIpoController.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file KX_WorldIpoController.h + * \ingroup ketsji + */ + #ifndef KX_WORLDIPOCONTROLLER_H #define KX_WORLDIPOCONTROLLER_H |