Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-05-11 13:06:49 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix doc comments

Browse source
This commit is contained in:
hispidence 2022-12-16 18:36:21 +00:00
parent 8af424dd3f
commit 1afcfac55b
4 changed files with 7 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

4
TombEngine/Scripting/Internal/TEN/Objects/Lara/LaraObject.cpp
View file

@ -239,7 +239,7 @@ int LaraObject::GetAmmoCount() const
/// Get current vehicle, if it exists /// Get current vehicle, if it exists
// @function LaraObject:GetVehicle // @function LaraObject:GetVehicle
// @treturn Moveable current vehicle (nil if no vehicle present) // @treturn Objects.Moveable current vehicle (nil if no vehicle present)
// @usage // @usage
// local vehicle = Lara:GetVehicle() // local vehicle = Lara:GetVehicle()
std::unique_ptr<Moveable> LaraObject::GetVehicle() const std::unique_ptr<Moveable> LaraObject::GetVehicle() const
@ -254,7 +254,7 @@ std::unique_ptr<Moveable> LaraObject::GetVehicle() const
/// Get current target enemy, if it exists /// Get current target enemy, if it exists
// @function LaraObject:GetTarget // @function LaraObject:GetTarget
// @treturn Moveable current target enemy (nil if no target present) // @treturn Objects.Moveable current target enemy (nil if no target present)
// @usage // @usage
// local target = Lara:GetTarget() // local target = Lara:GetTarget()
std::unique_ptr<Moveable> LaraObject::GetTarget() const std::unique_ptr<Moveable> LaraObject::GetTarget() const

2
TombEngine/Scripting/Internal/TEN/Objects/Moveable/MoveableObject.cpp
View file

@ -451,7 +451,7 @@ ScriptReserved_GetSlotHP, & Moveable::GetSlotHP,
/// Test if the object is in a valid state (i.e. has not been destroyed through Lua or killed by Lara). /// Test if the object is in a valid state (i.e. has not been destroyed through Lua or killed by Lara).
// @function Moveable:GetValid // @function Moveable:GetValid
// @treturn valid bool true if the object is still not destroyed // @treturn bool valid true if the object is still not destroyed
ScriptReserved_GetValid, &Moveable::GetValid, ScriptReserved_GetValid, &Moveable::GetValid,
/// Destroy the moveable. This will mean it can no longer be used, except to re-initialise it with another object. /// Destroy the moveable. This will mean it can no longer be used, except to re-initialise it with another object.

2
TombEngine/Scripting/Internal/TEN/Objects/Volume/VolumeObject.cpp
View file

@ -88,7 +88,7 @@ void Volume::Register(sol::table& parent)
/// Check if specified moveable is inside the volume /// Check if specified moveable is inside the volume
// @function Volume:IsMoveableInside // @function Volume:IsMoveableInside
// @tparam Moveable moveable which should be checked for containment // @tparam Objects.Moveable Moveable which should be checked for containment
ScriptReserved_IsMoveableInside, &Volume::IsMoveableInside); ScriptReserved_IsMoveableInside, &Volume::IsMoveableInside);
} }

6
TombEngine/Scripting/Internal/TEN/Rotation/Rotation.cpp
View file

@ -35,9 +35,9 @@ void Rotation::Register(sol::table& parent)
} }
/*** /***
@float X rotation about x axis @tparam float X rotation about x axis
@float Y rotation about y axis @tparam float Y rotation about y axis
@float Z rotation about z axis @tparam float Z rotation about z axis
@treturn Rotation A Rotation object. @treturn Rotation A Rotation object.
@function Rotation @function Rotation
*/ */