From 6074a440eb49eb5dfcf9d61645deea4fd8685db1 Mon Sep 17 00:00:00 2001 From: J0anJosep Date: Mon, 8 Apr 2024 18:01:07 +0200 Subject: [PATCH] Doc: Reorder comments of HasPowerOnRoad/Rail and IsCompatibleRail. --- src/rail.h | 4 ++-- src/road.h | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/rail.h b/src/rail.h index 0d6b09fe6c..149996aae0 100644 --- a/src/rail.h +++ b/src/rail.h @@ -315,9 +315,9 @@ inline const RailTypeInfo *GetRailTypeInfo(RailType railtype) * Checks if an engine of the given RailType can drive on a tile with a given * RailType. This would normally just be an equality check, but for electric * rails (which also support non-electric engines). - * @return Whether the engine can drive on this tile. * @param enginetype The RailType of the engine we are considering. * @param tiletype The RailType of the tile we are considering. + * @return Whether the engine can drive on this tile. */ inline bool IsCompatibleRail(RailType enginetype, RailType tiletype) { @@ -328,9 +328,9 @@ inline bool IsCompatibleRail(RailType enginetype, RailType tiletype) * Checks if an engine of the given RailType got power on a tile with a given * RailType. This would normally just be an equality check, but for electric * rails (which also support non-electric engines). - * @return Whether the engine got power on this tile. * @param enginetype The RailType of the engine we are considering. * @param tiletype The RailType of the tile we are considering. + * @return Whether the engine got power on this tile. */ inline bool HasPowerOnRail(RailType enginetype, RailType tiletype) { diff --git a/src/road.h b/src/road.h index 9328dd72c4..44f4fcd198 100644 --- a/src/road.h +++ b/src/road.h @@ -235,9 +235,9 @@ inline const RoadTypeInfo *GetRoadTypeInfo(RoadType roadtype) * Checks if an engine of the given RoadType got power on a tile with a given * RoadType. This would normally just be an equality check, but for electrified * roads (which also support non-electric vehicles). - * @return Whether the engine got power on this tile. * @param enginetype The RoadType of the engine we are considering. * @param tiletype The RoadType of the tile we are considering. + * @return Whether the engine got power on this tile. */ inline bool HasPowerOnRoad(RoadType enginetype, RoadType tiletype) {