diff options
Diffstat (limited to 'source/gameengine/Ketsji')
22 files changed, 80 insertions, 84 deletions
diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.cpp b/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.cpp index 014641a2d10..8c6392ee825 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.cpp +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.cpp @@ -23,7 +23,7 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Ketsji Logic Extenstion: Network Event Manager generic implementation + * Ketsji Logic Extension: Network Event Manager generic implementation */ /** \file gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.cpp diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.h b/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.h index 4f560428fbb..3202785ee81 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.h +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkEventManager.h @@ -27,7 +27,7 @@ /** \file KX_NetworkEventManager.h * \ingroup ketsjinet - * \brief Ketsji Logic Extenstion: Network Event Manager class + * \brief Ketsji Logic Extension: Network Event Manager class */ #ifndef __KX_NETWORKEVENTMANAGER_H__ diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.cpp b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.cpp index 9d5a6907c46..2741907bfe6 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.cpp +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.cpp @@ -23,7 +23,7 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Ketsji Logic Extenstion: Network Message Actuator generic implementation + * Ketsji Logic Extension: Network Message Actuator generic implementation */ /** \file gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.cpp diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.h b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.h index 3c8d8ec23d2..980e1cda6dc 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.h +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageActuator.h @@ -27,7 +27,7 @@ /** \file KX_NetworkMessageActuator.h * \ingroup ketsjinet - * \brief Ketsji Logic Extenstion: Network Message Actuator class + * \brief Ketsji Logic Extension: Network Message Actuator class */ #ifndef __KX_NETWORKMESSAGEACTUATOR_H__ diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.cpp b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.cpp index a39c8ede6c1..a69f02baa57 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.cpp +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.cpp @@ -23,7 +23,7 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Ketsji Logic Extenstion: Network Message Sensor generic implementation + * Ketsji Logic Extension: Network Message Sensor generic implementation */ /** \file gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.cpp diff --git a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.h b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.h index 0c76e718fa2..66f723d072c 100644 --- a/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.h +++ b/source/gameengine/Ketsji/KXNetwork/KX_NetworkMessageSensor.h @@ -27,7 +27,7 @@ /** \file KX_NetworkMessageSensor.h * \ingroup ketsjinet - * \brief Ketsji Logic Extenstion: Network Message Sensor class + * \brief Ketsji Logic Extension: Network Message Sensor class */ #ifndef __KX_NETWORKMESSAGESENSOR_H__ #define __KX_NETWORKMESSAGESENSOR_H__ diff --git a/source/gameengine/Ketsji/KX_Camera.h b/source/gameengine/Ketsji/KX_Camera.h index 082d363fed6..38fc170e371 100644 --- a/source/gameengine/Ketsji/KX_Camera.h +++ b/source/gameengine/Ketsji/KX_Camera.h @@ -191,7 +191,7 @@ public: void InvalidateProjectionMatrix(bool valid = false); /** Gets the modelview matrix that is used by the rasterizer. - * @warning If the Camera is a dynamic object then this method may return garbage. Use GetCameraToWorld() instead. + * \warning If the Camera is a dynamic object then this method may return garbage. Use GetCameraToWorld() instead. */ const MT_Matrix4x4& GetModelviewMatrix() const; @@ -217,21 +217,21 @@ public: /** * Tests if the given sphere is inside this camera's view frustum. * - * @param center The center of the sphere, in world coordinates. - * @param radius The radius of the sphere. - * @return INSIDE, INTERSECT, or OUTSIDE depending on the sphere's relation to the frustum. + * \param center The center of the sphere, in world coordinates. + * \param radius The radius of the sphere. + * \return INSIDE, INTERSECT, or OUTSIDE depending on the sphere's relation to the frustum. */ int SphereInsideFrustum(const MT_Point3& center, const MT_Scalar &radius); /** * Tests the given eight corners of a box with the view frustum. * - * @param box a pointer to eight MT_Point3 representing the world coordinates of the corners of the box. - * @return INSIDE, INTERSECT, or OUTSIDE depending on the box's relation to the frustum. + * \param box a pointer to eight MT_Point3 representing the world coordinates of the corners of the box. + * \return INSIDE, INTERSECT, or OUTSIDE depending on the box's relation to the frustum. */ int BoxInsideFrustum(const MT_Point3 *box); /** * Tests the given point against the view frustum. - * @return true if the given point is inside or on the view frustum; false if it is outside. + * \return true if the given point is inside or on the view frustum; false if it is outside. */ bool PointInsideFrustum(const MT_Point3& x); diff --git a/source/gameengine/Ketsji/KX_ConvertPhysicsObjects.cpp b/source/gameengine/Ketsji/KX_ConvertPhysicsObjects.cpp index ac83200cb2e..610200cc235 100644 --- a/source/gameengine/Ketsji/KX_ConvertPhysicsObjects.cpp +++ b/source/gameengine/Ketsji/KX_ConvertPhysicsObjects.cpp @@ -344,7 +344,7 @@ void KX_ConvertBulletObject( class KX_GameObject* gameobj, ci.m_linearDamping = 1.f - shapeprops->m_lin_drag; ci.m_angularDamping = 1.f - shapeprops->m_ang_drag; //need a bit of damping, else system doesn't behave well - ci.m_inertiaFactor = shapeprops->m_inertia/0.4f;//defaults to 0.4, don't want to change behaviour + ci.m_inertiaFactor = shapeprops->m_inertia/0.4f;//defaults to 0.4, don't want to change behavior ci.m_do_anisotropic = shapeprops->m_do_anisotropic; ci.m_anisotropicFriction.setValue(shapeprops->m_friction_scaling[0],shapeprops->m_friction_scaling[1],shapeprops->m_friction_scaling[2]); diff --git a/source/gameengine/Ketsji/KX_GameObject.cpp b/source/gameengine/Ketsji/KX_GameObject.cpp index c32dc6c1096..2740a2921d2 100644 --- a/source/gameengine/Ketsji/KX_GameObject.cpp +++ b/source/gameengine/Ketsji/KX_GameObject.cpp @@ -1271,7 +1271,7 @@ const MT_Point3& KX_GameObject::NodeGetLocalPosition() const } -/* Suspend/ resume: for the dynamic behaviour, there is a simple +/* Suspend/ resume: for the dynamic behavior, there is a simple * method. For the residual motion, there is not. I wonder what the * correct solution is for Sumo. Remove from the motion-update tree? * diff --git a/source/gameengine/Ketsji/KX_GameObject.h b/source/gameengine/Ketsji/KX_GameObject.h index ea721d19179..843fba15725 100644 --- a/source/gameengine/Ketsji/KX_GameObject.h +++ b/source/gameengine/Ketsji/KX_GameObject.h @@ -284,7 +284,7 @@ public: ); /** - * @section Stuff which is here due to poor design. + * \section Stuff which is here due to poor design. * Inherited from CValue and needs an implementation. * Do not expect these functions do to anything sensible. */ @@ -324,7 +324,7 @@ public: ); /** - * @section Inherited from CValue. These are the useful + * \section Inherited from CValue. These are the useful * part of the CValue interface that this class implements. */ @@ -428,7 +428,7 @@ public: ); /** - * @return a pointer to the physics controller owned by this class. + * \return a pointer to the physics controller owned by this class. */ KX_IPhysicsController* GetPhysicsController(); @@ -449,7 +449,7 @@ public: } /** - * @return a pointer to the graphic controller owner by this class + * \return a pointer to the graphic controller owner by this class */ PHY_IGraphicController* GetGraphicController() { @@ -466,7 +466,7 @@ public: void ActivateGraphicController(bool recurse); /** - * @section Coordinate system manipulation functions + * \section Coordinate system manipulation functions */ void NodeSetLocalPosition(const MT_Point3& trans ); @@ -496,7 +496,7 @@ public: const MT_Point3& NodeGetLocalPosition( ) const; /** - * @section scene graph node accessor functions. + * \section scene graph node accessor functions. */ SG_Node* GetSGNode( ) @@ -510,7 +510,7 @@ public: } /** - * @section blender object accessor functions. + * \section blender object accessor functions. */ struct Object* GetBlenderObject( ) @@ -572,7 +572,7 @@ public: /** - * @section Physics accessors for this node. + * \section Physics accessors for this node. * * All these calls get passed directly to the physics controller * owned by this object. @@ -673,7 +673,7 @@ public: ); /** - * @section Mesh accessor functions. + * \section Mesh accessor functions. */ /** @@ -829,7 +829,7 @@ public: ) { return m_bIsNegativeScaling; } /** - * @section Logic bubbling methods. + * \section Logic bubbling methods. */ /** @@ -885,7 +885,7 @@ public: #ifdef WITH_PYTHON /** - * @section Python interface functions. + * \section Python interface functions. */ virtual PyObject* py_repr(void) { diff --git a/source/gameengine/Ketsji/KX_IPhysicsController.cpp b/source/gameengine/Ketsji/KX_IPhysicsController.cpp index 62e3c346dd8..bd75246a97f 100644 --- a/source/gameengine/Ketsji/KX_IPhysicsController.cpp +++ b/source/gameengine/Ketsji/KX_IPhysicsController.cpp @@ -1,6 +1,4 @@ /* - * @file KX_IPhysicsController.cpp - * * ***** BEGIN GPL LICENSE BLOCK ***** * * This program is free software; you can redistribute it and/or @@ -48,5 +46,3 @@ KX_IPhysicsController::KX_IPhysicsController(bool dyna, bool sensor, bool compou KX_IPhysicsController::~KX_IPhysicsController() { } - - diff --git a/source/gameengine/Ketsji/KX_KetsjiEngine.cpp b/source/gameengine/Ketsji/KX_KetsjiEngine.cpp index 29727dc04da..b754e82046f 100644 --- a/source/gameengine/Ketsji/KX_KetsjiEngine.cpp +++ b/source/gameengine/Ketsji/KX_KetsjiEngine.cpp @@ -1447,7 +1447,7 @@ void KX_KetsjiEngine::RenderDebugProperties() { STR_String debugtxt; int xcoord = 10; // mmmm, these constants were taken from blender source - int ycoord = 14; // to 'mimic' behaviour + int ycoord = 14; // to 'mimic' behavior float tottime = m_logger->GetAverage(); if (tottime < 1e-6f) { diff --git a/source/gameengine/Ketsji/KX_KetsjiEngine.h b/source/gameengine/Ketsji/KX_KetsjiEngine.h index ab3126d90a0..7a29e2a2731 100644 --- a/source/gameengine/Ketsji/KX_KetsjiEngine.h +++ b/source/gameengine/Ketsji/KX_KetsjiEngine.h @@ -279,13 +279,13 @@ public: /** * Sets display of all frames. - * @param bUseFixedTime New setting for display all frames. + * \param bUseFixedTime New setting for display all frames. */ void SetUseFixedTime(bool bUseFixedTime); /** * Returns display of all frames. - * @return Current setting for display all frames. + * \return Current setting for display all frames. */ bool GetUseFixedTime(void) const; @@ -360,35 +360,35 @@ public: /** * Activates or deactivates timing information display. - * @param frameRate Display for frame rate on or off. - * @param profile Display for individual components on or off. - * @param properties Display of scene object debug properties on or off. + * \param frameRate Display for frame rate on or off. + * \param profile Display for individual components on or off. + * \param properties Display of scene object debug properties on or off. */ void SetTimingDisplay(bool frameRate, bool profile, bool properties); /** * Returns status of timing information display. - * @param frameRate Display for frame rate on or off. - * @param profile Display for individual components on or off. - * @param properties Display of scene object debug properties on or off. + * \param frameRate Display for frame rate on or off. + * \param profile Display for individual components on or off. + * \param properties Display of scene object debug properties on or off. */ void GetTimingDisplay(bool& frameRate, bool& profile, bool& properties) const; /** * Sets cursor hiding on every frame. - * @param hideCursor Turns hiding on or off. + * \param hideCursor Turns hiding on or off. */ void SetHideCursor(bool hideCursor); /** * Returns the current setting for cursor hiding. - * @return The current setting for cursor hiding. + * \return The current setting for cursor hiding. */ bool GetHideCursor(void) const; /** * Enables/disables the use of the framing bar color of the Blender file's scenes. - * @param overrideFrameColor The new setting. + * \param overrideFrameColor The new setting. */ void SetUseOverrideFrameColor(bool overrideFrameColor); @@ -399,17 +399,17 @@ public: /** * Set the color used for framing bar color instead of the one in the Blender file's scenes. - * @param r Red component of the override color. - * @param g Green component of the override color. - * @param b Blue component of the override color. + * \param r Red component of the override color. + * \param g Green component of the override color. + * \param b Blue component of the override color. */ void SetOverrideFrameColor(float r, float g, float b); /** * Returns the color used for framing bar color instead of the one in the Blender file's scenes. - * @param r Red component of the override color. - * @param g Green component of the override color. - * @param b Blue component of the override color. + * \param r Red component of the override color. + * \param g Green component of the override color. + * \param b Blue component of the override color. */ void GetOverrideFrameColor(float& r, float& g, float& b) const; @@ -424,7 +424,7 @@ protected: * Processes all scheduled scene activity. * At the end, if the scene lists have changed, * SceneListsChanged(void) is called. - * @see SceneListsChanged(void). + * \see SceneListsChanged(void). */ void ProcessScheduledScenes(void); diff --git a/source/gameengine/Ketsji/KX_MouseFocusSensor.cpp b/source/gameengine/Ketsji/KX_MouseFocusSensor.cpp index ed38694d2ca..c8a916e85b6 100644 --- a/source/gameengine/Ketsji/KX_MouseFocusSensor.cpp +++ b/source/gameengine/Ketsji/KX_MouseFocusSensor.cpp @@ -100,7 +100,7 @@ bool KX_MouseFocusSensor::Evaluate() // cout << "evaluate focus mouse sensor "<<endl; m_reset = false; if (m_focusmode) { - /* Focus behaviour required. Test mouse-on. The rest is + /* Focus behavior required. Test mouse-on. The rest is * equivalent to handling a key. */ obHasFocus = ParentObjectHasFocus(); @@ -123,7 +123,7 @@ bool KX_MouseFocusSensor::Evaluate() result = true; } } else { - /* No focus behaviour required: revert to the basic mode. This + /* No focus behavior required: revert to the basic mode. This * mode is never used, because the converter never makes this * sensor for a mouse-key event. It is here for * completeness. */ diff --git a/source/gameengine/Ketsji/KX_MouseFocusSensor.h b/source/gameengine/Ketsji/KX_MouseFocusSensor.h index a4c15fe0968..c8e9dc6b6b7 100644 --- a/source/gameengine/Ketsji/KX_MouseFocusSensor.h +++ b/source/gameengine/Ketsji/KX_MouseFocusSensor.h @@ -76,7 +76,7 @@ class KX_MouseFocusSensor : public SCA_MouseSensor /** - * @attention Overrides default evaluate. + * \attention Overrides default evaluate. */ virtual bool Evaluate(); virtual void Init(); diff --git a/source/gameengine/Ketsji/KX_PolygonMaterial.h b/source/gameengine/Ketsji/KX_PolygonMaterial.h index f20a90f7deb..1af8a72c1fd 100644 --- a/source/gameengine/Ketsji/KX_PolygonMaterial.h +++ b/source/gameengine/Ketsji/KX_PolygonMaterial.h @@ -89,7 +89,7 @@ public: /** * Returns the caching information for this material, * This can be used to speed up the rasterizing process. - * @return The caching information. + * \return The caching information. */ virtual TCachingInfo GetCachingInfo(void) const { @@ -100,8 +100,8 @@ public: * Activates the material in the (OpenGL) rasterizer. * On entry, the cachingInfo contains info about the last activated material. * On exit, the cachingInfo should contain updated info about this material. - * @param rasty The rasterizer in which the material should be active. - * @param cachingInfo The information about the material used to speed up rasterizing. + * \param rasty The rasterizer in which the material should be active. + * \param cachingInfo The information about the material used to speed up rasterizing. */ void DefaultActivate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const; virtual bool Activate(RAS_IRasterizer* rasty, TCachingInfo& cachingInfo) const; @@ -115,7 +115,7 @@ public: /** * Returns the Blender texture face structure that is used for this material. - * @return The material's texture face. + * \return The material's texture face. */ MTFace* GetMTFace(void) const { diff --git a/source/gameengine/Ketsji/KX_PythonInit.cpp b/source/gameengine/Ketsji/KX_PythonInit.cpp index 401474b21a9..7c47fc59ac5 100644 --- a/source/gameengine/Ketsji/KX_PythonInit.cpp +++ b/source/gameengine/Ketsji/KX_PythonInit.cpp @@ -1720,7 +1720,7 @@ PyObject* initGameLogic(KX_KetsjiEngine *engine, KX_Scene* scene) // quick hack * These exist so the current blend dir "//" can always be used to import modules from. * the reason we need a few functions for this is that python is not only used by the game engine * so we cant just add to sys.path all the time, it would leave pythons state in a mess. - * It would also be incorrect since loading blend files for new levels etc would alwasy add to sys.path + * It would also be incorrect since loading blend files for new levels etc would always add to sys.path * * To play nice with blenders python, the sys.path is backed up and the current blendfile along * with all its lib paths are added to the sys path. diff --git a/source/gameengine/Ketsji/KX_Scene.cpp b/source/gameengine/Ketsji/KX_Scene.cpp index 20743504dad..56127c7b634 100644 --- a/source/gameengine/Ketsji/KX_Scene.cpp +++ b/source/gameengine/Ketsji/KX_Scene.cpp @@ -362,7 +362,7 @@ void KX_Scene::SetFramingType(RAS_FrameSettings & frame_settings) /** * Return a const reference to the framing * type set by the above call. - * The contents are not guarenteed to be sensible + * The contents are not guaranteed to be sensible * if you don't call the above function. */ const RAS_FrameSettings& KX_Scene::GetFramingType() const diff --git a/source/gameengine/Ketsji/KX_Scene.h b/source/gameengine/Ketsji/KX_Scene.h index ca57548be2a..1fa981e18f9 100644 --- a/source/gameengine/Ketsji/KX_Scene.h +++ b/source/gameengine/Ketsji/KX_Scene.h @@ -53,7 +53,7 @@ #include "RAS_2DFilterManager.h" /** - * @section Forward declarations + * \section Forward declarations */ struct SM_MaterialProps; struct SM_ShapeProps; @@ -181,7 +181,7 @@ protected: KX_WorldInfo* m_worldinfo; /** - * @section Different scenes, linked to ketsji scene + * \section Different scenes, linked to ketsji scene */ /** @@ -191,7 +191,7 @@ protected: NG_NetworkScene* m_networkScene; /** - * A temoprary variable used to parent objects together on + * A temporary variable used to parent objects together on * replication. Don't get confused by the name it is not * the scene's root node! */ @@ -342,7 +342,7 @@ public: void RemoveAnimatedObject(CValue* gameobj); /** - * @section Logic stuff + * \section Logic stuff * Initiate an update of the logic system. */ void LogicBeginFrame(double curtime); @@ -451,7 +451,7 @@ public: /** * Activates new desired canvas width set at design time. - * @param width The new desired width. + * \param width The new desired width. */ void SetCanvasDesignWidth( @@ -459,7 +459,7 @@ public: ); /** * Activates new desired canvas height set at design time. - * @param width The new desired height. + * \param width The new desired height. */ void SetCanvasDesignHeight( @@ -467,7 +467,7 @@ public: ); /** * Returns the current desired canvas width set at design time. - * @return The desired width. + * \return The desired width. */ unsigned int GetCanvasDesignWidth( @@ -476,7 +476,7 @@ public: /** * Returns the current desired canvas height set at design time. - * @return The desired height. + * \return The desired height. */ unsigned int GetCanvasDesignHeight( @@ -495,7 +495,7 @@ public: /** * Return a const reference to the framing * type set by the above call. - * The contents are not guarenteed to be sensible + * The contents are not guaranteed to be sensible * if you don't call the above function. */ @@ -518,7 +518,7 @@ public: const RAS_Rect& GetSceneViewport() const; /** - * @section Accessors to different scenes of this scene + * \section Accessors to different scenes of this scene */ void SetNetworkDeviceInterface(NG_NetworkDeviceInterface* newInterface); void SetNetworkScene(NG_NetworkScene *newScene); diff --git a/source/gameengine/Ketsji/KX_SteeringActuator.cpp b/source/gameengine/Ketsji/KX_SteeringActuator.cpp index bc8c5ec92a8..f9af9fc3b8e 100644 --- a/source/gameengine/Ketsji/KX_SteeringActuator.cpp +++ b/source/gameengine/Ketsji/KX_SteeringActuator.cpp @@ -536,7 +536,7 @@ PyMethodDef KX_SteeringActuator::Methods[] = { }; PyAttributeDef KX_SteeringActuator::Attributes[] = { - KX_PYATTRIBUTE_INT_RW("behaviour", KX_STEERING_NODEF+1, KX_STEERING_MAX-1, true, KX_SteeringActuator, m_mode), + KX_PYATTRIBUTE_INT_RW("behavior", KX_STEERING_NODEF+1, KX_STEERING_MAX-1, true, KX_SteeringActuator, m_mode), KX_PYATTRIBUTE_RW_FUNCTION("target", KX_SteeringActuator, pyattr_get_target, pyattr_set_target), KX_PYATTRIBUTE_RW_FUNCTION("navmesh", KX_SteeringActuator, pyattr_get_navmesh, pyattr_set_navmesh), KX_PYATTRIBUTE_FLOAT_RW("distance", 0.0f, 1000.0f, KX_SteeringActuator, m_distance), diff --git a/source/gameengine/Ketsji/KX_TimeCategoryLogger.h b/source/gameengine/Ketsji/KX_TimeCategoryLogger.h index f01e405d3df..62b74871603 100644 --- a/source/gameengine/Ketsji/KX_TimeCategoryLogger.h +++ b/source/gameengine/Ketsji/KX_TimeCategoryLogger.h @@ -52,7 +52,7 @@ public: /** * Constructor. - * @param maxNumMesasurements Maximum number of measurements stored (> 1). + * \param maxNumMesasurements Maximum number of measurements stored (> 1). */ KX_TimeCategoryLogger(unsigned int maxNumMeasurements = 10); @@ -73,40 +73,40 @@ public: /** * Adds a category. - * @param category The new category. + * \param category The new category. */ virtual void AddCategory(TimeCategory tc); /** * Starts logging in current measurement for the given category. - * @param tc The category to log to. - * @param now The current time. - * @param endOtherCategories Whether to stop logging to other categories. + * \param tc The category to log to. + * \param now The current time. + * \param endOtherCategories Whether to stop logging to other categories. */ virtual void StartLog(TimeCategory tc, double now, bool endOtherCategories = true); /** * End logging in current measurement for the given category. - * @param tc The category to log to. - * @param now The current time. + * \param tc The category to log to. + * \param now The current time. */ virtual void EndLog(TimeCategory tc, double now); /** * End logging in current measurement for all categories. - * @param now The current time. + * \param now The current time. */ virtual void EndLog(double now); /** * Logs time in next measurement. - * @param now The current time. + * \param now The current time. */ virtual void NextMeasurement(double now); /** * Returns average of all but the current measurement time. - * @return The average of all but the current measurement. + * \return The average of all but the current measurement. */ virtual double GetAverage(TimeCategory tc); diff --git a/source/gameengine/Ketsji/KX_TimeLogger.h b/source/gameengine/Ketsji/KX_TimeLogger.h index 16d97c1fe41..b2336c2c512 100644 --- a/source/gameengine/Ketsji/KX_TimeLogger.h +++ b/source/gameengine/Ketsji/KX_TimeLogger.h @@ -49,7 +49,7 @@ class KX_TimeLogger { public: /** * Constructor. - * @param maxNumMesasurements Maximum number of measurements stored (>1). + * \param maxNumMesasurements Maximum number of measurements stored (>1). */ KX_TimeLogger(unsigned int maxNumMeasurements = 10); @@ -70,25 +70,25 @@ public: /** * Starts logging in current measurement. - * @param now The current time. + * \param now The current time. */ virtual void StartLog(double now); /** * End logging in current measurement. - * @param now The current time. + * \param now The current time. */ virtual void EndLog(double now); /** * Logs time in next measurement. - * @param now The current time. + * \param now The current time. */ virtual void NextMeasurement(double now); /** * Returns average of all but the current measurement. - * @return The average of all but the current measurement. + * \return The average of all but the current measurement. */ virtual double GetAverage(void) const; |