From 5138615554bee47a586209c7f4d3830758ff598e Mon Sep 17 00:00:00 2001 From: Nathan Letwory Date: Tue, 22 Feb 2011 10:33:14 +0000 Subject: doxygen: entries for blenderroutines, converter, expressions, gamelogic, gameplayer, ketsji --- source/gameengine/Ketsji/BL_BlenderShader.h | 32 ++++++++++++++++++++++ source/gameengine/Ketsji/BL_Material.h | 5 ++++ source/gameengine/Ketsji/BL_Shader.h | 5 ++++ source/gameengine/Ketsji/BL_Texture.h | 5 ++++ .../Ketsji/KXNetwork/KX_NetworkEventManager.h | 9 ++++-- .../Ketsji/KXNetwork/KX_NetworkMessageActuator.h | 9 ++++-- .../Ketsji/KXNetwork/KX_NetworkMessageSensor.h | 8 ++++-- .../Ketsji/KXNetwork/KX_NetworkObjectActuator.h | 2 +- .../Ketsji/KXNetwork/KX_NetworkObjectSensor.h | 2 +- source/gameengine/Ketsji/KX_ArmatureSensor.h | 9 ++++-- source/gameengine/Ketsji/KX_BlenderMaterial.h | 5 ++++ .../gameengine/Ketsji/KX_BulletPhysicsController.h | 5 ++++ source/gameengine/Ketsji/KX_Camera.h | 6 +++- source/gameengine/Ketsji/KX_CameraActuator.h | 6 +++- .../gameengine/Ketsji/KX_CameraIpoSGController.h | 7 ++++- source/gameengine/Ketsji/KX_ClientObjectInfo.h | 7 ++++- source/gameengine/Ketsji/KX_ConstraintActuator.h | 8 ++++-- source/gameengine/Ketsji/KX_ConstraintWrapper.h | 7 ++++- source/gameengine/Ketsji/KX_ConvertPhysicsObject.h | 7 ++++- source/gameengine/Ketsji/KX_Dome.h | 4 +++ source/gameengine/Ketsji/KX_EmptyObject.h | 7 ++++- source/gameengine/Ketsji/KX_FontObject.h | 7 ++++- source/gameengine/Ketsji/KX_GameActuator.h | 9 +++--- source/gameengine/Ketsji/KX_GameObject.h | 6 +++- source/gameengine/Ketsji/KX_IInterpolator.h | 7 ++++- source/gameengine/Ketsji/KX_IPOTransform.h | 9 ++++-- source/gameengine/Ketsji/KX_IPO_SGController.h | 7 ++++- source/gameengine/Ketsji/KX_IPhysicsController.h | 7 ++++- source/gameengine/Ketsji/KX_IScalarInterpolator.h | 7 ++++- source/gameengine/Ketsji/KX_ISceneConverter.h | 7 ++++- source/gameengine/Ketsji/KX_ISystem.h | 9 ++++-- source/gameengine/Ketsji/KX_IpoActuator.h | 9 ++++-- source/gameengine/Ketsji/KX_KetsjiEngine.h | 5 ++++ source/gameengine/Ketsji/KX_Light.h | 7 ++++- source/gameengine/Ketsji/KX_LightIpoSGController.h | 7 ++++- .../gameengine/Ketsji/KX_MaterialIpoController.h | 5 ++++ source/gameengine/Ketsji/KX_MeshProxy.h | 7 ++++- source/gameengine/Ketsji/KX_MotionState.h | 7 ++++- source/gameengine/Ketsji/KX_MouseFocusSensor.h | 8 ++++-- source/gameengine/Ketsji/KX_NearSensor.h | 9 ++++-- .../gameengine/Ketsji/KX_ObColorIpoSGController.h | 7 ++++- source/gameengine/Ketsji/KX_ObjectActuator.h | 9 ++++-- .../gameengine/Ketsji/KX_OrientationInterpolator.h | 7 ++++- source/gameengine/Ketsji/KX_ParentActuator.h | 10 ++++--- source/gameengine/Ketsji/KX_PhysicsEngineEnums.h | 7 ++++- source/gameengine/Ketsji/KX_PhysicsObjectWrapper.h | 7 ++++- .../Ketsji/KX_PhysicsPropertiesobsolete.h | 8 +++++- source/gameengine/Ketsji/KX_PolyProxy.h | 7 ++++- source/gameengine/Ketsji/KX_PolygonMaterial.h | 7 ++++- source/gameengine/Ketsji/KX_PositionInterpolator.h | 7 ++++- source/gameengine/Ketsji/KX_PyConstraintBinding.h | 7 ++++- source/gameengine/Ketsji/KX_PyMath.h | 8 ++++-- source/gameengine/Ketsji/KX_PythonInit.h | 7 ++++- source/gameengine/Ketsji/KX_PythonInitTypes.h | 6 +++- source/gameengine/Ketsji/KX_PythonSeq.h | 8 ++++-- source/gameengine/Ketsji/KX_RadarSensor.h | 7 ++++- source/gameengine/Ketsji/KX_RayCast.h | 6 +++- source/gameengine/Ketsji/KX_RayEventManager.h | 9 ++++-- source/gameengine/Ketsji/KX_RaySensor.h | 9 ++++-- .../gameengine/Ketsji/KX_SCA_AddObjectActuator.h | 15 ++++------ source/gameengine/Ketsji/KX_SCA_DynamicActuator.h | 8 ++++-- .../gameengine/Ketsji/KX_SCA_EndObjectActuator.h | 13 +++++---- .../gameengine/Ketsji/KX_SCA_ReplaceMeshActuator.h | 14 +++++----- .../Ketsji/KX_SG_BoneParentNodeRelationship.h | 21 ++++---------- source/gameengine/Ketsji/KX_SG_NodeRelationships.h | 30 ++++++++++---------- source/gameengine/Ketsji/KX_ScalarInterpolator.h | 7 ++++- source/gameengine/Ketsji/KX_ScalingInterpolator.h | 7 ++++- source/gameengine/Ketsji/KX_Scene.h | 7 ++++- source/gameengine/Ketsji/KX_SceneActuator.h | 8 +++--- source/gameengine/Ketsji/KX_SoundActuator.h | 8 ++++-- source/gameengine/Ketsji/KX_StateActuator.h | 6 +++- source/gameengine/Ketsji/KX_TimeCategoryLogger.h | 6 +++- source/gameengine/Ketsji/KX_TimeLogger.h | 6 +++- source/gameengine/Ketsji/KX_TouchEventManager.h | 7 ++++- source/gameengine/Ketsji/KX_TouchSensor.h | 9 ++++-- source/gameengine/Ketsji/KX_TrackToActuator.h | 7 +++-- source/gameengine/Ketsji/KX_VehicleWrapper.h | 5 ++++ source/gameengine/Ketsji/KX_VertexProxy.h | 7 ++++- source/gameengine/Ketsji/KX_VisibilityActuator.h | 6 +++- source/gameengine/Ketsji/KX_WorldInfo.h | 7 ++++- source/gameengine/Ketsji/KX_WorldIpoController.h | 7 ++++- 81 files changed, 487 insertions(+), 161 deletions(-) (limited to 'source/gameengine/Ketsji') 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 -- cgit v1.2.3