Changeset - r26129:f1a3379c4130
[Not reviewed]
master
0 5 0
Joan Josep - 3 years ago 2021-12-19 15:51:45
juanjo.ng.83@gmail.com
Cleanup #9725: Clean up Doxygen docs and fix typo. (#9753)
5 files changed with 1 insertions and 8 deletions:
0 comments (0 inline, 0 general)
src/group_cmd.cpp
Show inline comments
 
@@ -656,13 +656,12 @@ static void SetGroupFlag(Group *g, Group
 
	}
 
}
 

	
 
/**
 
 * (Un)set group flag from a group
 
 * @param flags type of operation
 
 * @param tile unused
 
 * @param group_id index of group array
 
 * @param flag flag to set, by value not bit.
 
 * @param value value to set the flag to.
 
 * @param recursive to apply to sub-groups.
 
 * @return the cost of this operation or an error
 
 */
src/order_cmd.cpp
Show inline comments
 
@@ -726,13 +726,12 @@ uint GetOrderDistance(const Order *prev,
 
	return v->type == VEH_AIRCRAFT ? DistanceSquare(prev_tile, cur_tile) : DistanceManhattan(prev_tile, cur_tile);
 
}
 

	
 
/**
 
 * Add an order to the orderlist of a vehicle.
 
 * @param flags operation to perform
 
 * @param p1 various bitstuffed elements
 
 * @param veh ID of the vehicle
 
 * @param sel_ord the selected order (if any). If the last order is given,
 
 *                        the order will be inserted before that one
 
 *                        the maximum vehicle order id is 254.
 
 * @param new_order order to insert
 
 * @return the cost of this operation or an error
src/rail_cmd.cpp
Show inline comments
 
@@ -955,13 +955,12 @@ CommandCost CmdRemoveRailroadTrack(DoCom
 
/**
 
 * Build a train depot
 
 * @param flags operation to perform
 
 * @param tile position of the train depot
 
 * @param railtype rail type
 
 * @param dir entrance direction
 
 * @param text unused
 
 * @return the cost of this operation or an error
 
 *
 
 * @todo When checking for the tile slope,
 
 * distinguish between "Flat land required" and "land sloped in wrong direction"
 
 */
 
CommandCost CmdBuildTrainDepot(DoCommandFlag flags, TileIndex tile, RailType railtype, DiagDirection dir)
src/town_cmd.cpp
Show inline comments
 
@@ -2779,18 +2779,15 @@ const CargoSpec *FindFirstCargoWithTownE
 
	return nullptr;
 
}
 

	
 
/**
 
 * Change the cargo goal of a town.
 
 * @param flags Type of operation.
 
 * @param tile Unused.
 
 * @param p1 various bitstuffed elements
 
 * @param town_id Town ID to cargo game of.
 
 * @param te TownEffect to change the game of.
 
 * @param goal The new goal value.
 
 * @param text Unused.
 
 * @return Empty cost or an error.
 
 */
 
CommandCost CmdTownCargoGoal(DoCommandFlag flags, TownID town_id, TownEffect te, uint32 goal)
 
{
 
	if (_current_company != OWNER_DEITY) return CMD_ERROR;
 

	
src/vehicle_cmd.cpp
Show inline comments
 
@@ -195,17 +195,16 @@ std::tuple<CommandCost, VehicleID, uint,
 
	return { value, veh_id, refitted_capacity, refitted_mail_capacity };
 
}
 

	
 
/**
 
 * Sell a vehicle.
 
 * @param flags for command.
 
 * @aram v_id vehicle ID being sold.
 
 * @param v_id vehicle ID being sold.
 
 * @param sell_chain sell the vehicle and all vehicles following it in the chain.
 
 * @param backup_order make a backup of the vehicle's order (if an engine).
 
 * @param client_id User.
 
 * @param text unused.
 
 * @return the cost of this operation or an error.
 
 */
 
CommandCost CmdSellVehicle(DoCommandFlag flags, VehicleID v_id, bool sell_chain, bool backup_order, ClientID client_id)
 
{
 
	Vehicle *v = Vehicle::GetIfValid(v_id);
 
	if (v == nullptr) return CMD_ERROR;
0 comments (0 inline, 0 general)