Codechange: Fix all doxygen warnings related to train.h file.

Fixes 14 doxygen warnings.
The `head` parameter of `GroundVehicle::GetPoweredPartPower` virtual method is removed as it's always the same as the object it's called on.
This commit is contained in:
Rito12
2026-02-20 16:14:33 +01:00
committed by rubidium42
parent dde097a080
commit 7179ea8b02
5 changed files with 26 additions and 15 deletions
+4
View File
@@ -437,6 +437,10 @@ void Train::UpdateAcceleration()
this->acceleration = Clamp(power / weight * 4, 1, 255);
}
/**
* Get the offset for train image when it is used as cursor.
* @return The offset in horizontal direction.
*/
int Train::GetCursorImageOffset() const
{
if (this->gcache.cached_veh_length != 8 && this->flags.Test(VehicleRailFlag::Flipped) && !EngInfo(this->engine_type)->misc_flags.Test(EngineMiscFlag::RailFlips)) {