dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix missing parameter documentation for vehicle on pos functions

Browse Source
This commit is contained in:
Jonathan G Rennison
2024-06-27 20:48:52 +01:00
parent 991bde6600
commit 93d2b6716e
2 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/vehicle.cpp
View File

@@ -556,6 +556,7 @@ Vehicle *VehicleFromPosXY(int x, int y, VehicleType type, void *data, VehicleFro
* Helper function for FindVehicleOnPos/HasVehicleOnPos. * Helper function for FindVehicleOnPos/HasVehicleOnPos.
* @note Do not call this function directly! * @note Do not call this function directly!
* @param tile The location on the map * @param tile The location on the map
* @param type The vehicle type
* @param data Arbitrary data passed to \a proc. * @param data Arbitrary data passed to \a proc.
* @param proc The proc that determines whether a vehicle will be "found". * @param proc The proc that determines whether a vehicle will be "found".
* @param find_first Whether to return on the first found or iterate over * @param find_first Whether to return on the first found or iterate over

4
src/vehicle_func.h
View File

@@ -55,6 +55,7 @@ uint CountVehiclesInChain(const Vehicle *v);
* @note Use this function when you have the intention that all vehicles * @note Use this function when you have the intention that all vehicles
* should be iterated over. * should be iterated over.
* @param tile The location on the map * @param tile The location on the map
* @param type The vehicle type
* @param data Arbitrary data passed to \a proc. * @param data Arbitrary data passed to \a proc.
* @param proc The proc that determines whether a vehicle will be "found". * @param proc The proc that determines whether a vehicle will be "found".
*/ */
@@ -70,6 +71,7 @@ inline void FindVehicleOnPos(TileIndex tile, VehicleType type, void *data, Vehic
* @note Use #FindVehicleOnPos when you have the intention that all vehicles * @note Use #FindVehicleOnPos when you have the intention that all vehicles
* should be iterated over. * should be iterated over.
* @param tile The location on the map * @param tile The location on the map
* @param type The vehicle type
* @param data Arbitrary data passed to \a proc. * @param data Arbitrary data passed to \a proc.
* @param proc The \a proc that determines whether a vehicle will be "found". * @param proc The \a proc that determines whether a vehicle will be "found".
* @return True if proc returned non-nullptr. * @return True if proc returned non-nullptr.
@@ -91,6 +93,7 @@ inline bool HasVehicleOnPos(TileIndex tile, VehicleType type, void *data, Vehicl
* should be iterated over. * should be iterated over.
* @param x The X location on the map * @param x The X location on the map
* @param y The Y location on the map * @param y The Y location on the map
* @param type The vehicle type
* @param data Arbitrary data passed to proc * @param data Arbitrary data passed to proc
* @param proc The proc that determines whether a vehicle will be "found". * @param proc The proc that determines whether a vehicle will be "found".
*/ */
@@ -107,6 +110,7 @@ inline void FindVehicleOnPosXY(int x, int y, VehicleType type, void *data, Vehic
* should be iterated over. * should be iterated over.
* @param x The X location on the map * @param x The X location on the map
* @param y The Y location on the map * @param y The Y location on the map
* @param type The vehicle type
* @param data Arbitrary data passed to proc * @param data Arbitrary data passed to proc
* @param proc The proc that determines whether a vehicle will be "found". * @param proc The proc that determines whether a vehicle will be "found".
* @return True if proc returned non-nullptr. * @return True if proc returned non-nullptr.