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/gameengine/GameLogic | |
parent | 7729ecc98f0e9890ff0fc7c3a49a516b8807bafc (diff) |
doxygen: entries for blenderroutines, converter, expressions, gamelogic, gameplayer, ketsji
Diffstat (limited to 'source/gameengine/GameLogic')
43 files changed, 264 insertions, 104 deletions
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 |