cpp/openttd-patchpack/source Changeset - r13057:58af81fcdcf8

Changeset - r13057:58af81fcdcf8

Parent rev.

Child rev.

[Not reviewed]

master

0 29 0

rubidium - 15 years ago 2009-09-18 14:23:58
rubidium@openttd.org

(svn r17567) -Fix: some doxygen warnings

29 files changed with 231 insertions and 24 deletions:

Doxyfile

src/aircraft_cmd.cpp

src/autoreplace_cmd.cpp

src/command.cpp

src/company_cmd.cpp

src/economy.cpp

src/engine.cpp

src/group_cmd.cpp

src/industry_cmd.cpp

src/landscape.cpp

src/misc_cmd.cpp

src/order_cmd.cpp

src/rail_cmd.cpp

src/road_cmd.cpp

src/roadveh_cmd.cpp

src/settings.cpp

src/ship_cmd.cpp

src/signs_cmd.cpp

src/station_cmd.cpp

src/terraform_cmd.cpp

src/timetable_cmd.cpp

src/town_cmd.cpp

src/train_cmd.cpp

src/tree_cmd.cpp

src/tunnelbridge_cmd.cpp

src/unmovable_cmd.cpp

src/vehicle_cmd.cpp

src/water_cmd.cpp

src/waypoint_cmd.cpp

0 comments (0 inline, 0 general)

Doxyfile

➞

Show inline comments

@@ @@ -30,13 +30,12 @@ INLINE_INHERITED_MEMB = NO @@
 FULL_PATH_NAMES        = YES
 STRIP_FROM_PATH        = ./
 STRIP_FROM_INC_PATH    =
 SHORT_NAMES            = NO
 JAVADOC_AUTOBRIEF      = YES
 MULTILINE_CPP_IS_BRIEF = NO
 DETAILS_AT_TOP         = NO
 INHERIT_DOCS           = YES
 DISTRIBUTE_GROUP_DOC   = NO
 TAB_SIZE               = 2
 ALIASES                =
 OPTIMIZE_OUTPUT_FOR_C  = YES
 OPTIMIZE_OUTPUT_JAVA   = NO
@@ @@ -92,13 +91,13 @@ FILE_PATTERNS = *.c \ @@
                          *.h \
                          *.hpp \
                          table/*.h
 RECURSIVE              = YES
 EXCLUDE                =
 EXCLUDE_SYMLINKS       = NO
 EXCLUDE_PATTERNS       =
+EXCLUDE_PATTERNS       = */3rdparty */.svn
 EXAMPLE_PATH           =
 EXAMPLE_PATTERNS       = *
 EXAMPLE_RECURSIVE      = NO
 IMAGE_PATH             =
 INPUT_FILTER           =
 FILTER_PATTERNS        =

src/aircraft_cmd.cpp

➞

Show inline comments

@@ @@ -250,13 +250,14 @@ uint16 AircraftDefaultCargoCapacity(Carg @@
 /** Build an aircraft.
  * @param tile tile of depot where aircraft is built
  * @param flags for command
  * @param p1 aircraft type being built (engine)
  * @param p2 unused
  * return result of operation.  Could be cost, error
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildAircraft(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (!IsEngineBuildable(p1, VEH_AIRCRAFT, _current_company)) return_cmd_error(STR_ERROR_AIRCRAFT_NOT_AVAILABLE);
 	const AircraftVehicleInfo *avi = AircraftVehInfo(p1);
@@ @@ -446,13 +447,14 @@ CommandCost CmdBuildAircraft(TileIndex t @@
 /** Sell an aircraft.
  * @param tile unused
  * @param flags for command type
  * @param p1 vehicle ID to be sold
  * @param p2 unused
  * @return result of operation.  Error or sold value
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSellAircraft(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Aircraft *v = Aircraft::GetIfValid(p1);
 	if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
@@ @@ -492,13 +494,14 @@ bool Aircraft::FindClosestDepot(TileInde @@
  * @param tile unused
  * @param flags for command type
  * @param p1 vehicle ID to send to the hangar
  * @param p2 various bitmasked elements
  * - p2 bit 0-3 - DEPOT_ flags (see vehicle.h)
  * - p2 bit 8-10 - VLW flag (for mass goto depot)
  * @return o if everything went well
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSendAircraftToHangar(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (p2 & DEPOT_MASS_SEND) {
 		/* Mass goto depot requested */
 		if (!ValidVLWFlags(p2 & VLW_MASK)) return CMD_ERROR;
@@ @@ -517,13 +520,14 @@ CommandCost CmdSendAircraftToHangar(Tile @@
  * @param flags for command type
  * @param p1 vehicle ID of the aircraft to refit
  * @param p2 various bitstuffed elements
  * - p2 = (bit 0-7) - the new cargo type to refit to
  * - p2 = (bit 8-15) - the new cargo subtype to refit to
  * - p2 = (bit 16) - refit only this vehicle (ignored)
  * @return cost of refit or error
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRefitAircraft(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	byte new_subtype = GB(p2, 8, 8);
 	Aircraft *v = Aircraft::GetIfValid(p1);

src/autoreplace_cmd.cpp

➞

Show inline comments

@@ @@ -611,12 +611,14 @@ static CommandCost ReplaceChain(Vehicle @@
 /** Autoreplaces a vehicle
  * Trains are replaced as a whole chain, free wagons in depot are replaced on their own
  * @param tile not used
  * @param flags type of operation
  * @param p1 Index of vehicle
  * @param p2 not used
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdAutoreplaceVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost = CommandCost(EXPENSES_NEW_VEHICLES, 0);
 	bool nothing_to_do = true;

src/command.cpp

➞

Show inline comments

@@ @@ -396,12 +396,13 @@ CommandCost DoCommand(const CommandConta @@
+ *
  * @param tile The tile to apply the command on (for the #CommandProc)
  * @param p1 Additional data for the command (for the #CommandProc)
  * @param p2 Additional data for the command (for the #CommandProc)
  * @param flags Flags for the command and how to execute the command
  * @param cmd The command-id to execute (a value of the CMD_* enums)
  * @param text The text to pass
  * @see CommandProc
  * @return the cost
  */
 CommandCost DoCommand(TileIndex tile, uint32 p1, uint32 p2, DoCommandFlag flags, uint32 cmd, const char *text)
+{
 	CommandCost res;

src/company_cmd.cpp

➞

Show inline comments

@@ @@ -615,12 +615,13 @@ void CompaniesYearlyLoop() @@
  * @param p1 packed data
  *   - bits 16-31 = engine group
  * @param p2 packed data
  *   - bits  0-15 = old engine type
  *   - bits 16-31 = new engine type
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSetAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Company *c = Company::GetIfValid(_current_company);
 	if (c == NULL) return CMD_ERROR;
@@ @@ -677,12 +678,15 @@ void CompanyNewsInformation::FillData(co @@
  * - p1 = 1 - create a new AI company
  * - p1 = 2 - delete a company. Company is identified by p2
  * @param p2 various functionality, dictated by p1
  * - p1 = 0 - ClientID of the newly created client
  * - p1 = 1 - CompanyID to start AI (INVALID_COMPANY for first available)
  * - p1 = 2 - CompanyID of the that is getting deleted
  * @param text unused
  * @return the cost of this operation or an error
+ *
  * @todo In the case of p1=0, create new company, the clientID of the new client is in parameter
  * p2. This parameter is passed in at function DEF_SERVER_RECEIVE_COMMAND(PACKET_CLIENT_COMMAND)
  * on the server itself. First of all this is unbelievably ugly; second of all, well,
  * it IS ugly! <b>Someone fix this up :)</b> So where to fix?@n
  * @arg - network_server.c:838 DEF_SERVER_RECEIVE_COMMAND(PACKET_CLIENT_COMMAND)@n
  * @arg - network_client.c:536 DEF_CLIENT_RECEIVE_COMMAND(PACKET_SERVER_MAP) from where the map has been received

src/economy.cpp

➞

Show inline comments

@@ @@ -1457,12 +1457,14 @@ extern int GetAmountOwnedBy(const Compan @@
 /** Acquire shares in an opposing company.
  * @param tile unused
  * @param flags type of operation
  * @param p1 company to buy the shares from
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuyShareInCompany(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost(EXPENSES_OTHER);
 	Company *c = Company::GetIfValid(p1);
@@ @@ -1502,12 +1504,14 @@ CommandCost CmdBuyShareInCompany(TileInd @@
 /** Sell shares in an opposing company.
  * @param tile unused
  * @param flags type of operation
  * @param p1 company to sell the shares from
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSellShareInCompany(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Company *c = Company::GetIfValid(p1);
 	/* Check if selling shares is allowed (protection against modified clients)
@@ @@ -1535,12 +1539,14 @@ CommandCost CmdSellShareInCompany(TileIn @@
  * that company.
  * @todo currently this only works for AI companies
  * @param tile unused
  * @param flags type of operation
  * @param p1 company to buy up
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuyCompany(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Company *c = Company::GetIfValid(p1);
 	if (c == NULL) return CMD_ERROR;

src/engine.cpp

➞

Show inline comments

@@ @@ -601,12 +601,14 @@ void EnginesDailyLoop() @@
 /** Accept an engine prototype. XXX - it is possible that the top-company
  * changes while you are waiting to accept the offer? Then it becomes invalid
  * @param tile unused
  * @param flags operation to perfom
  * @param p1 engine-prototype offered
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdWantEnginePreview(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Engine *e = Engine::GetIfValid(p1);
 	if (e == NULL || GetBestCompany(e->preview_company_rank) != _current_company) return CMD_ERROR;
@@ @@ -710,12 +712,14 @@ static bool IsUniqueEngineName(const cha @@
 /** Rename an engine.
  * @param tile unused
  * @param flags operation to perfom
  * @param p1 engine ID to rename
  * @param p2 unused
  * @param text the new name or an empty string when resetting to the default
  * @return the cost of this operation or an error
  */
 CommandCost CmdRenameEngine(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Engine *e = Engine::GetIfValid(p1);
 	if (e == NULL) return CMD_ERROR;

src/group_cmd.cpp

➞

Show inline comments

@@ @@ -72,14 +72,17 @@ void InitializeGroup() @@
+}
 /**
  * Create a new vehicle group.
  * @param tile unused
  * @param flags type of operation
  * @param p1   vehicle type
  * @param p2   unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdCreateGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleType vt = (VehicleType)p1;
 	if (!IsCompanyBuildableVehicleType(vt)) return CMD_ERROR;
@@ @@ -99,15 +102,18 @@ CommandCost CmdCreateGroup(TileIndex til @@
+}
 /**
  * Add all vehicles in the given group to the default group and then deletes the group.
  * @param tile unused
  * @param flags type of operation
  * @param p1   index of array group
  *      - p1 bit 0-15 : GroupID
  * @param p2   unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdDeleteGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Group *g = Group::GetIfValid(p1);
 	if (g == NULL || g->owner != _current_company) return CMD_ERROR;
@@ @@ -156,15 +162,18 @@ static bool IsUniqueGroupName(const char @@
 	return true;
+}
 /**
  * Rename a group
  * @param tile unused
  * @param flags type of operation
  * @param p1   index of array group
  *   - p1 bit 0-15 : GroupID
  * @param p2   unused
  * @param text the new name or an empty string when resetting to the default
  * @return the cost of this operation or an error
  */
 CommandCost CmdRenameGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Group *g = Group::GetIfValid(p1);
 	if (g == NULL || g->owner != _current_company) return CMD_ERROR;
@@ @@ -188,16 +197,19 @@ CommandCost CmdRenameGroup(TileIndex til @@
+}
 /**
  * Add a vehicle to a group
  * @param tile unused
  * @param flags type of operation
  * @param p1   index of array group
  *   - p1 bit 0-15 : GroupID
  * @param p2   vehicle to add to a group
  *   - p2 bit 0-15 : VehicleID
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdAddVehicleGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Vehicle *v = Vehicle::GetIfValid(p2);
 	GroupID new_g = p1;
@@ @@ -235,15 +247,18 @@ CommandCost CmdAddVehicleGroup(TileIndex @@
 	return CommandCost();
+}
 /**
  * Add all shared vehicles of all vehicles from a group
  * @param tile unused
  * @param flags type of operation
  * @param p1   index of group array
  *  - p1 bit 0-15 : GroupID
  * @param p2   type of vehicles
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdAddSharedVehicleGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleType type = (VehicleType)p2;
 	if (!Group::IsValidID(p1) || !IsCompanyBuildableVehicleType(type)) return CMD_ERROR;
@@ @@ -272,15 +287,18 @@ CommandCost CmdAddSharedVehicleGroup(Til @@
+}
 /**
  * Remove all vehicles from a group
  * @param tile unused
  * @param flags type of operation
  * @param p1   index of group array
  * - p1 bit 0-15 : GroupID
  * @param p2   type of vehicles
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRemoveAllVehiclesGroup(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Group *g = Group::GetIfValid(p1);
 	VehicleType type = (VehicleType)p2;
@@ @@ -307,16 +325,19 @@ CommandCost CmdRemoveAllVehiclesGroup(Ti @@
+}
 /**
  * (Un)set global replace protection from a group
  * @param tile unused
  * @param flags type of operation
  * @param p1   index of group array
  * - p1 bit 0-15 : GroupID
  * @param p2
  * - p2 bit 0    : 1 to set or 0 to clear protection.
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSetGroupReplaceProtection(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Group *g = Group::GetIfValid(p1);
 	if (g == NULL || g->owner != _current_company) return CMD_ERROR;

src/industry_cmd.cpp

➞

Show inline comments

@@ @@ -1689,13 +1689,14 @@ static Industry *CreateNewIndustryHelper @@
  * @param tile tile where industry is built
  * @param flags of operations to conduct
  * @param p1 various bitstuffed elements
  * - p1 = (bit  0 -  7) - industry type see build_industry.h and see industry.h
  * - p1 = (bit  8 - 15) - first layout to try
  * @param p2 seed to use for variable 8F
  * @return index of the newly create industry, or CMD_ERROR if it failed
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildIndustry(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	IndustryType it = GB(p1, 0, 8);
 	if (it >= NUM_INDUSTRYTYPES) return CMD_ERROR;

src/landscape.cpp

➞

Show inline comments

@@ @@ -591,23 +591,27 @@ void ClearSnowLine() @@
 /** Clear a piece of landscape
  * @param tile tile to clear
  * @param flags of operation to conduct
  * @param p1 unused
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdLandscapeClear(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	return _tile_type_procs[GetTileType(tile)]->clear_tile_proc(tile, flags);
+}
 /** Clear a big piece of landscape
  * @param tile end tile of area dragging
  * @param p1 start tile of area dragging
  * @param flags of operation to conduct
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdClearArea(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (p1 >= MapSize()) return CMD_ERROR;
 	/* make sure sx,sy are smaller than ex,ey */

src/misc_cmd.cpp

➞

Show inline comments

@@ @@ -31,12 +31,14 @@ @@
 /** Change the company manager's face.
  * @param tile unused
  * @param flags operation to perform
  * @param p1 unused
  * @param p2 face bitmasked
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSetCompanyManagerFace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CompanyManagerFace cmf = (CompanyManagerFace)p2;
 	if (!IsValidCompanyManagerFace(cmf)) return CMD_ERROR;
@@ @@ -52,12 +54,14 @@ CommandCost CmdSetCompanyManagerFace(Til @@
  * @param tile unused
  * @param flags operation to perform
  * @param p1 bitstuffed:
  * p1 bits 0-7 scheme to set
  * p1 bits 8-9 set in use state or first/second colour
  * @param p2 new colour for vehicles, property, etc.
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSetCompanyColour(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (p2 >= 16) return CMD_ERROR; // max 16 colours
 	Colours colour = (Colours)p2;
@@ @@ -139,12 +143,14 @@ CommandCost CmdSetCompanyColour(TileInde @@
  * @param tile unused
  * @param flags operation to perform
  * @param p1 amount to increase the loan with, multitude of LOAN_INTERVAL. Only used when p2 == 2.
  * @param p2 when 0: loans LOAN_INTERVAL
  *           when 1: loans the maximum loan permitting money (press CTRL),
  *           when 2: loans the amount specified in p1
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdIncreaseLoan(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Company *c = Company::Get(_current_company);
 	if (c->current_loan >= _economy.max_loan) {
@@ @@ -183,12 +189,14 @@ CommandCost CmdIncreaseLoan(TileIndex ti @@
  * @param tile unused
  * @param flags operation to perform
  * @param p1 amount to decrease the loan with, multitude of LOAN_INTERVAL. Only used when p2 == 2.
  * @param p2 when 0: pays back LOAN_INTERVAL
  *           when 1: pays back the maximum loan permitting money (press CTRL),
  *           when 2: pays back the amount specified in p1
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdDecreaseLoan(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Company *c = Company::Get(_current_company);
 	if (c->current_loan == 0) return_cmd_error(STR_ERROR_LOAN_ALREADY_REPAYED);
@@ @@ -235,12 +243,14 @@ static bool IsUniqueCompanyName(const ch @@
 /** Change the name of the company.
  * @param tile unused
  * @param flags operation to perform
  * @param p1 unused
  * @param p2 unused
  * @param text the new name or an empty string when resetting to the default
  * @return the cost of this operation or an error
  */
 CommandCost CmdRenameCompany(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	bool reset = StrEmpty(text);
 	if (!reset) {
@@ @@ -271,12 +281,14 @@ static bool IsUniquePresidentName(const @@
 /** Change the name of the president.
  * @param tile unused
  * @param flags operation to perform
  * @param p1 unused
  * @param p2 unused
  * @param text the new name or an empty string when resetting to the default
  * @return the cost of this operation or an error
  */
 CommandCost CmdRenamePresident(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	bool reset = StrEmpty(text);
 	if (!reset) {
@@ @@ -323,12 +335,14 @@ static void AskUnsafeUnpauseCallback(Win @@
  * the game is unpaused. A counter is used instead of a boolean value
  * to have more control over the game when saving/loading, etc.
  * @param tile unused
  * @param flags operation to perform
  * @param p1 the pause mode to change
  * @param p2 1 pauses, 0 unpauses this mode
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdPause(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	switch (p1) {
 		case PM_PAUSED_SAVELOAD:
 		case PM_PAUSED_ERROR:
@@ @@ -364,12 +378,14 @@ CommandCost CmdPause(TileIndex tile, DoC @@
  * This is normally only enabled in offline mode, but if there is a debug
  * build, you can cheat (to test).
  * @param tile unused
  * @param flags operation to perform
  * @param p1 the amount of money to receive (if negative), or spend (if positive)
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdMoneyCheat(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 #ifndef _DEBUG
 	if (_networking) return CMD_ERROR;
 #endif
@@ @@ -381,12 +397,14 @@ CommandCost CmdMoneyCheat(TileIndex tile @@
  * companies if you have paid off your loan (either explicitely, or implicitely
  * given the fact that you have more money than loan).
  * @param tile unused
  * @param flags operation to perform
  * @param p1 the amount of money to transfer; max 20.000.000
  * @param p2 the company to transfer the money to
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdGiveMoney(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (!_settings_game.economy.give_money) return CMD_ERROR;
 	const Company *c = Company::Get(_current_company);

src/order_cmd.cpp

➞

Show inline comments

@@ @@ -447,12 +447,14 @@ static uint GetOrderDistance(const Order @@
  * @param p1 various bitstuffed elements
  * - p1 = (bit  0 - 15) - ID of the vehicle
  * - p1 = (bit 16 - 31) - 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 p2 packed order to insert
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdInsertOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleID veh   = GB(p1,  0, 16);
 	VehicleOrderID sel_ord = GB(p1, 16, 16);
 	Order new_order(p2);
@@ @@ -703,12 +705,14 @@ static CommandCost DecloneOrder(Vehicle @@
 /** Delete an order from the orderlist of a vehicle.
  * @param tile unused
  * @param flags operation to perform
  * @param p1 the ID of the vehicle
  * @param p2 the order to delete (max 255)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdDeleteOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleID veh_id = p1;
 	VehicleOrderID sel_ord = p2;
 	Order *order;
@@ @@ -768,12 +772,14 @@ CommandCost CmdDeleteOrder(TileIndex til @@
 /** Goto order of order-list.
  * @param tile unused
  * @param flags operation to perform
  * @param p1 The ID of the vehicle which order is skipped
  * @param p2 the selected order to which we want to skip
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSkipToOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleID veh_id = p1;
 	VehicleOrderID sel_ord = p2;
@@ @@ -801,16 +807,19 @@ CommandCost CmdSkipToOrder(TileIndex til @@
 	return CommandCost();
+}
 /**
  * Move an order inside the orderlist
  * @param tile unused
  * @param flags operation to perform
  * @param p1 the ID of the vehicle
  * @param p2 order to move and target
  *           bit 0-15  : the order to move
  *           bit 16-31 : the target order
  * @param text unused
  * @return the cost of this operation or an error
  * @note The target order will move one place down in the orderlist
  *  if you move the order upwards else it'll move it one place down
  */
 CommandCost CmdMoveOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleID veh = p1;
@@ @@ -883,12 +892,14 @@ CommandCost CmdMoveOrder(TileIndex tile, @@
  * - p1 = (bit 16 - 31) - the selected order (if any). If the last order is given,
  *                        the order will be inserted before that one
  *                        only the first 8 bits used currently (bit 16 - 23) (max 255)
  * @param p2 various bitstuffed elements
  *  - p2 = (bit 0 -  3) - what data to modify (@see ModifyOrderFlags)
  *  - p2 = (bit 4 - 15) - the data to modify
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdModifyOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleOrderID sel_ord = GB(p1, 16, 16); // XXX - automatically truncated to 8 bits.
 	VehicleID veh          = GB(p1,  0, 16);
 	ModifyOrderFlags mof   = (ModifyOrderFlags)GB(p2,  0,  4);
@@ @@ -1108,12 +1119,14 @@ CommandCost CmdModifyOrder(TileIndex til @@
  * @param tile unused
  * @param flags operation to perform
  * @param p1 various bitstuffed elements
  * - p1 = (bit  0-15) - destination vehicle to clone orders to (p1 & 0xFFFF)
  * - p1 = (bit 16-31) - source vehicle to clone orders from, if any (none for CO_UNSHARE)
  * @param p2 mode of cloning: CO_SHARE, CO_COPY, or CO_UNSHARE
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdCloneOrder(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleID veh_src = GB(p1, 16, 16);
 	VehicleID veh_dst = GB(p1,  0, 16);
@@ @@ -1230,12 +1243,14 @@ CommandCost CmdCloneOrder(TileIndex tile @@
  * @param flags operation to perform
  * @param p1 VehicleIndex of the vehicle having the order
  * @param p2 bitmask
  *   - bit 0-7 CargoID
  *   - bit 8-15 Cargo subtype
  *   - bit 16-23 number of order to modify
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdOrderRefit(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleID veh = GB(p1, 0, 16);
 	VehicleOrderID order_number  = GB(p2, 16, 8);
 	CargoID cargo = GB(p2, 0, 8);
@@ @@ -1375,12 +1390,14 @@ void RestoreVehicleOrders(const Vehicle @@
  * @param tile unused
  * @param flags operation to perform
  * @param p1 the ID of the vehicle
  * @param p2 various bistuffed elements
  * - p2 = (bit  0-15) - current order-index (p2 & 0xFFFF)
  * - p2 = (bit 16-31) - service interval (p2 >> 16)
  * @param text unused
  * @return the cost of this operation or an error
  * @todo Unfortunately you cannot safely restore the unitnumber or the old vehicle
  * as far as I can see. We can store it in BackuppedOrders, and restore it, but
  * but we have no way of seeing it has been tampered with or not, as we have no
  * legit way of knowing what that ID was.@n
  * If we do want to backup/restore it, just add UnitID uid to BackuppedOrders, and
  * restore it as parameter 'y' (ugly hack I know) for example. "v->unitnumber = y;"

src/rail_cmd.cpp

➞

Show inline comments

@@ @@ -307,12 +307,14 @@ static inline bool ValParamTrackOrientat @@
 /** Build a single piece of rail
  * @param tile tile  to build on
  * @param flags operation to perform
  * @param p1 railtype of being built piece (normal, mono, maglev)
  * @param p2 rail track to build
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildSingleRail(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Slope tileh;
 	RailType railtype = (RailType)p1;
 	Track track = (Track)p2;
@@ @@ -444,12 +446,14 @@ CommandCost CmdBuildSingleRail(TileIndex @@
 /** Remove a single piece of track
  * @param tile tile to remove track from
  * @param flags operation to perform
  * @param p1 unused
  * @param p2 rail orientation
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRemoveSingleRail(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Track track = (Track)p2;
 	TrackBits trackbit;
 	CommandCost cost(EXPENSES_CONSTRUCTION, _price.remove_rail );
@@ @@ -672,12 +676,14 @@ static CommandCost ValidateAutoDrag(Trac @@
  * @param flags operation to perform
  * @param p1 end tile of drag
  * @param p2 various bitstuffed elements
  * - p2 = (bit 0-3) - railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev)
  * - p2 = (bit 4-6) - track-orientation, valid values: 0-5 (Track enum)
  * - p2 = (bit 7)   - 0 = build, 1 = remove tracks
  * @param text unused
  * @return the cost of this operation or an error
  */
 static CommandCost CmdRailTrackHelper(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost ret, total_cost(EXPENSES_CONSTRUCTION);
 	Track track = (Track)GB(p2, 4, 3);
 	bool remove = HasBit(p2, 7);
@@ @@ -719,12 +725,14 @@ static CommandCost CmdRailTrackHelper(Ti @@
  * @param flags operation to perform
  * @param p1 end tile of drag
  * @param p2 various bitstuffed elements
  * - p2 = (bit 0-3) - railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev)
  * - p2 = (bit 4-6) - track-orientation, valid values: 0-5 (Track enum)
  * - p2 = (bit 7)   - 0 = build, 1 = remove tracks
  * @param text unused
  * @return the cost of this operation or an error
  * @see CmdRailTrackHelper
  */
 CommandCost CmdBuildRailroadTrack(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	return CmdRailTrackHelper(tile, flags, p1, ClrBit(p2, 7), text);
+}
@@ @@ -735,24 +743,28 @@ CommandCost CmdBuildRailroadTrack(TileIn @@
  * @param flags operation to perform
  * @param p1 end tile of drag
  * @param p2 various bitstuffed elements
  * - p2 = (bit 0-3) - railroad type normal/maglev (0 = normal, 1 = mono, 2 = maglev)
  * - p2 = (bit 4-6) - track-orientation, valid values: 0-5 (Track enum)
  * - p2 = (bit 7)   - 0 = build, 1 = remove tracks
  * @param text unused
  * @return the cost of this operation or an error
  * @see CmdRailTrackHelper
  */
 CommandCost CmdRemoveRailroadTrack(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	return CmdRailTrackHelper(tile, flags, p1, SetBit(p2, 7), text);
+}
 /** Build a train depot
  * @param tile position of the train depot
  * @param flags operation to perform
  * @param p1 rail type
  * @param p2 bit 0..1 entrance direction (DiagDirection)
  * @param text unused
  * @return the cost of this operation or an error
+ *
  * @todo When checking for the tile slope,
  * distingush between "Flat land required" and "land sloped in wrong direction"
  */
 CommandCost CmdBuildTrainDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
@@ @@ -814,13 +826,15 @@ CommandCost CmdBuildTrainDepot(TileIndex @@
  * - p1 = (bit 8)   - convert the present signal type and variant
  * - p1 = (bit 9-11)- start cycle from this signal type
  * - p1 = (bit 12-14)-wrap around after this signal type
  * - p1 = (bit 15-16)-cycle the signal direction this many times
  * - p1 = (bit 17)  - 1 = don't modify an existing signal but don't fail either, 0 = always set new signal type
  * @param p2 used for CmdBuildManySignals() to copy direction of first signal
  * TODO: p2 should be replaced by two bits for "along" and "against" the track.
  * @param text unused
  * @return the cost of this operation or an error
  * @todo p2 should be replaced by two bits for "along" and "against" the track.
  */
 CommandCost CmdBuildSingleSignal(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Track track = (Track)GB(p1, 0, 3);
 	bool ctrl_pressed = HasBit(p1, 3); // was the CTRL button pressed
 	SignalVariant sigvar = (ctrl_pressed ^ HasBit(p1, 4)) ? SIG_SEMAPHORE : SIG_ELECTRIC; // the signal variant of the new signal
@@ @@ -1030,12 +1044,14 @@ static bool CheckSignalAutoFill(TileInde @@
  * - p2 = (bit  3)    - 1 = override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
  * - p2 = (bit  4)    - 0 = signals, 1 = semaphores
  * - p2 = (bit  5)    - 0 = build, 1 = remove signals
  * - p2 = (bit  6)    - 0 = selected stretch, 1 = auto fill
  * - p2 = (bit  7- 9) - default signal type
  * - p2 = (bit 24-31) - user defined signals_density
  * @param text unused
  * @return the cost of this operation or an error
  */
 static CommandCost CmdSignalTrackHelper(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost ret, total_cost(EXPENSES_CONSTRUCTION);
 	int signal_ctr;
 	byte signals;
@@ @@ -1156,12 +1172,14 @@ static CommandCost CmdSignalTrackHelper( @@
  * - p2 = (bit  3)    - 1 = override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
  * - p2 = (bit  4)    - 0 = signals, 1 = semaphores
  * - p2 = (bit  5)    - 0 = build, 1 = remove signals
  * - p2 = (bit  6)    - 0 = selected stretch, 1 = auto fill
  * - p2 = (bit  7- 9) - default signal type
  * - p2 = (bit 24-31) - user defined signals_density
  * @param text unused
  * @return the cost of this operation or an error
  * @see CmdSignalTrackHelper
  */
 CommandCost CmdBuildSignalTrack(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	return CmdSignalTrackHelper(tile, flags, p1, p2, text);
+}
@@ @@ -1171,12 +1189,14 @@ CommandCost CmdBuildSignalTrack(TileInde @@
  * @param flags operation to perform
  * @param p1 various bitstuffed elements, only track information is used
  *           - (bit  0- 2) - track-orientation, valid values: 0-5 (Track enum)
  *           - (bit  3)    - override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
  *           - (bit  4)    - 0 = signals, 1 = semaphores
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRemoveSingleSignal(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Track track = (Track)GB(p1, 0, 3);
 	if (!ValParamTrackOrientation(track) ||
@@ @@ -1225,12 +1245,14 @@ CommandCost CmdRemoveSingleSignal(TileIn @@
  * - p2 = (bit  3)    - 1 = override signal/semaphore, or pre/exit/combo signal (CTRL-toggle)
  * - p2 = (bit  4)    - 0 = signals, 1 = semaphores
  * - p2 = (bit  5)    - 0 = build, 1 = remove signals
  * - p2 = (bit  6)    - 0 = selected stretch, 1 = auto fill
  * - p2 = (bit  7- 9) - default signal type
  * - p2 = (bit 24-31) - user defined signals_density
  * @param text unused
  * @return the cost of this operation or an error
  * @see CmdSignalTrackHelper
  */
 CommandCost CmdRemoveSignalTrack(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	return CmdSignalTrackHelper(tile, flags, p1, SetBit(p2, 5), text); // bit 5 is remove bit
+}
@@ @@ -1254,12 +1276,14 @@ Vehicle *UpdateTrainPowerProc(Vehicle *v @@
 /** Convert one rail type to the other. You can convert normal rail to
  * monorail/maglev easily or vice-versa.
  * @param tile end tile of rail conversion drag
  * @param flags operation to perform
  * @param p1 start tile of drag
  * @param p2 new railtype to convert to
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdConvertRail(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost(EXPENSES_CONSTRUCTION);
 	RailType totype = (RailType)p2;

src/road_cmd.cpp

➞

Show inline comments

@@ @@ -354,12 +354,14 @@ static CommandCost RemoveRoad(TileIndex @@
 /** Delete a piece of road.
  * @param tile tile where to remove road from
  * @param flags operation to perform
  * @param p1 bit 0..3 road pieces to remove (RoadBits)
  *           bit 4..5 road type
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRemoveRoad(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	RoadType rt = (RoadType)GB(p1, 4, 2);
 	if (!IsValidRoadType(rt)) return CMD_ERROR;
@@ @@ -448,12 +450,14 @@ static CommandCost CheckRoadSlope(Slope @@
  * @param tile tile where to build road
  * @param flags operation to perform
  * @param p1 bit 0..3 road pieces to build (RoadBits)
  *           bit 4..5 road type
  *           bit 6..7 disallowed directions to toggle
  * @param p2 the town that is building the road (0 if not applicable)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildRoad(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost(EXPENSES_CONSTRUCTION);
 	RoadBits existing = ROAD_NONE;
@@ @@ -700,12 +704,14 @@ do_clear:; @@
  * @param p2 various bitstuffed elements
  * - p2 = (bit 0) - start tile starts in the 2nd half of tile (p2 & 1)
  * - p2 = (bit 1) - end tile starts in the 2nd half of tile (p2 & 2)
  * - p2 = (bit 2) - direction: 0 = along x-axis, 1 = along y-axis (p2 & 4)
  * - p2 = (bit 3 + 4) - road type
  * - p2 = (bit 5) - set road direction
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildLongRoad(TileIndex end_tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost(EXPENSES_CONSTRUCTION);
 	bool had_bridge = false;
 	bool had_tunnel = false;
@@ @@ -786,12 +792,14 @@ CommandCost CmdBuildLongRoad(TileIndex e @@
  * @param p1 start tile of drag
  * @param p2 various bitstuffed elements
  * - p2 = (bit 0) - start tile starts in the 2nd half of tile (p2 & 1)
  * - p2 = (bit 1) - end tile starts in the 2nd half of tile (p2 & 2)
  * - p2 = (bit 2) - direction: 0 = along x-axis, 1 = along y-axis (p2 & 4)
  * - p2 = (bit 3 + 4) - road type
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRemoveLongRoad(TileIndex end_tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost(EXPENSES_CONSTRUCTION);
 	if (p1 >= MapSize()) return CMD_ERROR;
@@ @@ -848,12 +856,14 @@ CommandCost CmdRemoveLongRoad(TileIndex @@
 /** Build a road depot.
  * @param tile tile where to build the depot
  * @param flags operation to perform
  * @param p1 bit 0..1 entrance direction (DiagDirection)
  *           bit 2..3 road type
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
+ *
  * @todo When checking for the tile slope,
  * distingush between "Flat land required" and "land sloped in wrong direction"
  */
 CommandCost CmdBuildRoadDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{

src/roadveh_cmd.cpp

➞

Show inline comments

@@ @@ -182,12 +182,14 @@ void RoadVehUpdateCache(RoadVehicle *v) @@
 /** Build a road vehicle.
  * @param tile tile of depot where road vehicle is built
  * @param flags operation to perform
  * @param p1 bus/truck type being built (engine)
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildRoadVeh(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (!IsEngineBuildable(p1, VEH_ROAD, _current_company)) return_cmd_error(STR_ERROR_ROAD_VEHICLE_NOT_AVAILABLE);
 	const Engine *e = Engine::Get(p1);
@@ @@ -337,12 +339,14 @@ bool RoadVehicle::IsStoppedInDepot() con @@
 /** Sell a road vehicle.
  * @param tile unused
  * @param flags operation to perform
  * @param p1 vehicle ID to be sold
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSellRoadVeh(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	RoadVehicle *v = RoadVehicle::GetIfValid(p1);
 	if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
@@ @@ -445,12 +449,14 @@ bool RoadVehicle::FindClosestDepot(TileI @@
  * @param tile unused
  * @param flags operation to perform
  * @param p1 vehicle ID to send to the depot
  * @param p2 various bitmasked elements
  * - p2 bit 0-3 - DEPOT_ flags (see vehicle.h)
  * - p2 bit 8-10 - VLW flag (for mass goto depot)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSendRoadVehToDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (p2 & DEPOT_MASS_SEND) {
 		/* Mass goto depot requested */
 		if (!ValidVLWFlags(p2 & VLW_MASK)) return CMD_ERROR;
@@ @@ -465,12 +471,14 @@ CommandCost CmdSendRoadVehToDepot(TileIn @@
 /** Turn a roadvehicle around.
  * @param tile unused
  * @param flags operation to perform
  * @param p1 vehicle ID to turn
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdTurnRoadVeh(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	RoadVehicle *v = RoadVehicle::GetIfValid(p1);
 	if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
@@ @@ -1989,13 +1997,14 @@ Trackdir RoadVehicle::GetVehicleTrackdir @@
  * @param flags operation to perform
  * @param p1 Vehicle ID of the vehicle to refit
  * @param p2 Bitstuffed elements
  * - p2 = (bit 0-7) - the new cargo type to refit to
  * - p2 = (bit 8-15) - the new cargo subtype to refit to
  * - p2 = (bit 16) - refit only this vehicle
  * @return cost of refit or error
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRefitRoadVeh(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost(EXPENSES_ROADVEH_RUN);
 	CargoID new_cid = GB(p2, 0, 8);
 	byte new_subtype = GB(p2, 8, 8);

src/settings.cpp

➞

Show inline comments

@@ @@ -1407,12 +1407,14 @@ static const SettingDesc *GetSettingDesc @@
 /** Network-safe changing of settings (server-only).
  * @param tile unused
  * @param flags operation to perform
  * @param p1 the index of the setting in the SettingDesc array which identifies it
  * @param p2 the new value for the setting
  * The new value is properly clamped to its minimum/maximum when setting
  * @param text unused
  * @return the cost of this operation or an error
  * @see _settings
  */
 CommandCost CmdChangeSetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	const SettingDesc *sd = GetSettingDescription(p1);
@@ @@ -1455,12 +1457,14 @@ CommandCost CmdChangeSetting(TileIndex t @@
 /** Change one of the per-company settings.
  * @param tile unused
  * @param flags operation to perform
  * @param p1 the index of the setting in the _company_settings array which identifies it
  * @param p2 the new value for the setting
  * The new value is properly clamped to its minimum/maximum when setting
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdChangeCompanySetting(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (p1 >= lengthof(_company_settings)) return CMD_ERROR;
 	const SettingDesc *sd = &_company_settings[p1];

src/ship_cmd.cpp

➞

Show inline comments

@@ @@ -732,12 +732,14 @@ bool Ship::Tick() @@
 /** Build a ship.
  * @param tile tile of depot where ship is built
  * @param flags type of operation
  * @param p1 ship type being built (engine)
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildShip(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	UnitID unit_num;
 	if (!IsEngineBuildable(p1, VEH_SHIP, _current_company)) return_cmd_error(STR_ERROR_SHIP_NOT_AVAILABLE);
@@ @@ -831,12 +833,14 @@ CommandCost CmdBuildShip(TileIndex tile, @@
 /** Sell a ship.
  * @param tile unused
  * @param flags type of operation
  * @param p1 vehicle ID to be sold
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSellShip(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Ship *v = Ship::GetIfValid(p1);
 	if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
@@ @@ -871,12 +875,14 @@ bool Ship::FindClosestDepot(TileIndex *l @@
  * @param tile unused
  * @param flags type of operation
  * @param p1 vehicle ID to send to the depot
  * @param p2 various bitmasked elements
  * - p2 bit 0-3 - DEPOT_ flags (see vehicle.h)
  * - p2 bit 8-10 - VLW flag (for mass goto depot)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSendShipToDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (p2 & DEPOT_MASS_SEND) {
 		/* Mass goto depot requested */
 		if (!ValidVLWFlags(p2 & VLW_MASK)) return CMD_ERROR;
@@ @@ -895,13 +901,14 @@ CommandCost CmdSendShipToDepot(TileIndex @@
  * @param flags type of operation
  * @param p1 vehicle ID of the ship to refit
  * @param p2 various bitstuffed elements
  * - p2 = (bit 0-7) - the new cargo type to refit to (p2 & 0xFF)
  * - p2 = (bit 8-15) - the new cargo subtype to refit to
  * - p2 = (bit 16) - refit only this vehicle (ignored)
  * @return cost of refit or error
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRefitShip(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost(EXPENSES_SHIP_RUN);
 	CargoID new_cid = GB(p2, 0, 8); // gets the cargo number
 	byte new_subtype = GB(p2, 8, 8);

src/signs_cmd.cpp

➞

Show inline comments

@@ @@ -29,12 +29,14 @@ SignID _new_sign_id; @@
  * no effect whatsoever except for the colour the sign gets for easy recognition,
  * but everybody is able to rename/remove it.
  * @param tile tile to place sign at
  * @param flags type of operation
  * @param p1 unused
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdPlaceSign(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	/* Try to locate a new sign */
 	if (!Sign::CanAllocateItem()) return_cmd_error(STR_ERROR_TOO_MANY_SIGNS);
@@ @@ -65,13 +67,14 @@ CommandCost CmdPlaceSign(TileIndex tile, @@
  * the user wanted to delete it. So delete it. Ownership of signs
  * has no meaning/effect whatsoever except for eyecandy
  * @param tile unused
  * @param flags type of operation
  * @param p1 index of the sign to be renamed/removed
  * @param p2 unused
  * @return 0 if succesfull, otherwise CMD_ERROR
  * @param text the new name or an empty string when resetting to the default
  * @return the cost of this operation or an error
  */
 CommandCost CmdRenameSign(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Sign *si = Sign::GetIfValid(p1);
 	if (si == NULL) return CMD_ERROR;

src/station_cmd.cpp

➞

Show inline comments

@@ @@ -947,12 +947,14 @@ CommandCost FindJoiningWaypoint(StationI @@
  * - p1 = (bit 16-23) - platform length
  * - p1 = (bit 24)    - allow stations directly adjacent to other stations.
  * @param p2 various bitstuffed elements
  * - p2 = (bit  0- 7) - custom station class
  * - p2 = (bit  8-15) - custom station id
  * - p2 = (bit 16-31) - station ID to join (NEW_STATION if build new one)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildRailStation(TileIndex tile_org, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	/* Unpack parameters */
 	RailType rt    = (RailType)GB(p1, 0, 4);
 	Axis axis      = Extract<Axis, 4>(p1);
@@ @@ -1325,13 +1327,13 @@ CommandCost RemoveFromRailBaseStation(Ti @@
  * @param start tile of station piece to remove
  * @param flags operation to perform
  * @param p1 start_tile
  * @param p2 various bitstuffed elements
  * - p2 = bit 0 - if set keep the rail
  * @param text unused
  * @return cost of operation or error
+ * @return the cost of this operation or an error
  */
 CommandCost CmdRemoveFromRailStation(TileIndex start, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	TileIndex end = p1 == 0 ? start : p1;
 	if (start >= MapSize() || end >= MapSize()) return CMD_ERROR;
@@ @@ -1359,13 +1361,13 @@ CommandCost CmdRemoveFromRailStation(Til @@
  * @param start tile of waypoint piece to remove
  * @param flags operation to perform
  * @param p1 start_tile
  * @param p2 various bitstuffed elements
  * - p2 = bit 0 - if set keep the rail
  * @param text unused
  * @return cost of operation or error
+ * @return the cost of this operation or an error
  */
 CommandCost CmdRemoveFromRailWaypoint(TileIndex start, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	TileIndex end = p1 == 0 ? start : p1;
 	if (start >= MapSize() || end >= MapSize()) return CMD_ERROR;
@@ @@ -1505,12 +1507,14 @@ static RoadStop **FindRoadStopSpot(bool @@
  * @param p1 entrance direction (DiagDirection)
  * @param p2 bit 0: 0 for Bus stops, 1 for truck stops
  *           bit 1: 0 for normal, 1 for drive-through
  *           bit 2..3: the roadtypes
  *           bit 5: allow stations directly adjacent to other stations.
  *           bit 16..31: station ID to join (NEW_STATION if build new one)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildRoadStop(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	bool type = HasBit(p2, 0);
 	bool is_drive_through = HasBit(p2, 1);
 	bool build_over_road  = is_drive_through && IsNormalRoadTile(tile);
@@ @@ -1726,12 +1730,14 @@ static CommandCost RemoveRoadStop(TileIn @@
 /** Remove a bus or truck stop
  * @param tile tile to remove the stop from
  * @param flags operation to perform
  * @param p1 not used
  * @param p2 bit 0: 0 for Bus stops, 1 for truck stops
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRemoveRoadStop(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	/* Make sure the specified tile is a road stop of the correct type */
 	if (!IsTileType(tile, MP_STATION) || !IsRoadStop(tile) || (uint32)GetRoadStopType(tile) != GB(p2, 0, 1)) return CMD_ERROR;
@@ @@ -1863,12 +1869,14 @@ void UpdateAirportsNoise() @@
  * @param tile tile where airport will be built
  * @param flags operation to perform
  * @param p1 airport type, @see airport.h
  * @param p2 various bitstuffed elements
  * - p2 = (bit     0) - allow airports directly adjacent to other airports.
  * - p2 = (bit 16-31) - station ID to join (NEW_STATION if build new one)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildAirport(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	bool airport_upgrade = true;
 	StationID station_to_join = GB(p2, 16, 16);
 	bool reuse = (station_to_join != NEW_STATION);
@@ @@ -2113,12 +2121,14 @@ static const byte _dock_h_chk[4] = { 1, @@
 /** Build a dock/haven.
  * @param tile tile where dock will be built
  * @param flags operation to perform
  * @param p1 (bit 0) - allow docks directly adjacent to other docks.
  * @param p2 bit 16-31: station ID to join (NEW_STATION if build new one)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildDock(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	StationID station_to_join = GB(p2, 16, 16);
 	bool reuse = (station_to_join != NEW_STATION);
 	if (!reuse) station_to_join = INVALID_STATION;
@@ @@ -2926,12 +2936,14 @@ static bool IsUniqueStationName(const ch @@
 /** Rename a station
  * @param tile unused
  * @param flags operation to perform
  * @param p1 station ID that is to be renamed
  * @param p2 unused
  * @param text the new name or an empty string when resetting to the default
  * @return the cost of this operation or an error
  */
 CommandCost CmdRenameStation(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Station *st = Station::GetIfValid(p1);
 	if (st == NULL || !CheckOwnership(st->owner)) return CMD_ERROR;

src/terraform_cmd.cpp

➞

Show inline comments

@@ @@ -230,13 +230,14 @@ static CommandCost TerraformTileHeight(T @@
 /** Terraform land
  * @param tile tile to terraform
  * @param flags for this command type
  * @param p1 corners to terraform (SLOPE_xxx)
  * @param p2 direction; eg up (non-zero) or down (zero)
  * @return error or cost of terraforming
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdTerraformLand(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	_terraform_err_tile = INVALID_TILE;
 	CommandCost total_cost(EXPENSES_CONSTRUCTION);
@@ @@ -356,13 +357,14 @@ CommandCost CmdTerraformLand(TileIndex t @@
 /** Levels a selected (rectangle) area of land
  * @param tile end tile of area-drag
  * @param flags for this command type
  * @param p1 start tile of area drag
  * @param p2 height difference; eg raise (+1), lower (-1) or level (0)
  * @return  error or cost of terraforming
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdLevelLand(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (p1 >= MapSize()) return CMD_ERROR;
 	_terraform_err_tile = INVALID_TILE;

src/timetable_cmd.cpp

➞

Show inline comments

@@ @@ -55,12 +55,14 @@ static void ChangeTimetable(Vehicle *v, @@
  *                      time.
  * - p1 = (bit    25) - Whether p2 contains waiting and travelling time.
  * @param p2 The amount of time to wait.
  * - p2 = (bit  0-15) - Waiting or travelling time as specified by p1 bit 24 if p1 bit 25 is not set,
  *                      Travelling time if p1 bit 25 is set.
  * - p2 = (bit 16-31) - Waiting time if p1 bit 25 is set
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdChangeTimetable(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (!_settings_game.order.timetabling) return CMD_ERROR;
 	VehicleID veh = GB(p1, 0, 16);
@@ @@ -112,12 +114,15 @@ CommandCost CmdChangeTimetable(TileIndex @@
 /**
  * Clear the lateness counter to make the vehicle on time.
  * @param tile Not used.
  * @param flags Operation to perform.
  * @param p1 Various bitstuffed elements
  * - p1 = (bit  0-15) - Vehicle with the orders to change.
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSetVehicleOnTime(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (!_settings_game.order.timetabling) return CMD_ERROR;
 	VehicleID veh = GB(p1, 0, 16);
@@ @@ -139,12 +144,14 @@ CommandCost CmdSetVehicleOnTime(TileInde @@
  * @param tile Not used.
  * @param flags Operation to perform.
  * @param p1 Vehicle index.
  * @param p2 Various bitstuffed elements
  * - p2 = (bit 0) - Set to 1 to enable, 0 to disable autofill.
  * - p2 = (bit 1) - Set to 1 to preserve waiting times in non-destructive mode
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdAutofillTimetable(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (!_settings_game.order.timetabling) return CMD_ERROR;
 	VehicleID veh = GB(p1, 0, 16);

src/town_cmd.cpp

➞

Show inline comments

@@ @@ -1589,12 +1589,14 @@ static CommandCost TownCanBePlacedHere(T @@
  * @param tile coordinates where town is built
  * @param flags type of operation
  * @param p1  0..1 size of the town (@see TownSize)
  *               2 true iff it should be a city
  *            3..5 town road layout (@see TownLayout)
  * @param p2 town name parts
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildTown(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	/* Only in the scenario editor */
 	if (_game_mode != GM_EDITOR) return CMD_ERROR;
@@ @@ -2301,12 +2303,14 @@ static bool IsUniqueTownName(const char @@
 /** Rename a town (server-only).
  * @param tile unused
  * @param flags type of operation
  * @param p1 town ID to rename
  * @param p2 unused
  * @param text the new name or an empty string when resetting to the default
  * @return the cost of this operation or an error
  */
 CommandCost CmdRenameTown(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Town *t = Town::GetIfValid(p1);
 	if (t == NULL) return CMD_ERROR;
@@ @@ -2573,12 +2577,14 @@ uint GetMaskOfTownActions(int *nump, Com @@
  * This performs an action such as advertising, building a statue, funding buildings,
  * but also bribing the town-council
  * @param tile unused
  * @param flags type of operation
  * @param p1 town to do the action at
  * @param p2 action to perform, @see _town_action_proc for the list of available actions
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdDoTownAction(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Town *t = Town::GetIfValid(p1);
 	if (t == NULL || p2 >= lengthof(_town_action_proc)) return CMD_ERROR;

src/train_cmd.cpp

➞

Show inline comments

@@ @@ -829,12 +829,14 @@ static void AddRearEngineToMultiheadedTr @@
 /** Build a railroad vehicle.
  * @param tile tile of the depot where rail-vehicle is built
  * @param flags type of operation
  * @param p1 engine type id
  * @param p2 bit 1 prevents any free cars from being added to the train
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildRailVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	/* Check if the engine-type is valid (for the company) */
 	if (!IsEngineBuildable(p1, VEH_TRAIN, _current_company)) return_cmd_error(STR_ERROR_RAIL_VEHICLE_NOT_AVAILABLE);
@@ @@ -1084,12 +1086,14 @@ static void NormaliseTrainConsist(Train @@
  * @param flags type of operation
  *              Note: DC_AUTOREPLACE is set when autoreplace tries to undo its modifications or moves vehicles to temporary locations inside the depot.
  * @param p1 various bitstuffed elements
  * - p1 (bit  0 - 15) source vehicle index
  * - p1 (bit 16 - 31) what wagon to put the source wagon AFTER, XXX - INVALID_VEHICLE to make a new line
  * @param p2 (bit 0) move all vehicles following the source vehicle
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdMoveRailVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleID s = GB(p1, 0, 16);
 	VehicleID d = GB(p1, 16, 16);
@@ @@ -1437,12 +1441,14 @@ CommandCost CmdMoveRailVehicle(TileIndex @@
  * @param flags type of operation
  * @param p1 the wagon/engine index
  * @param p2 the selling mode
  * - p2 = 0: only sell the single dragged wagon/engine (and any belonging rear-engines)
  * - p2 = 1: sell the vehicle and all vehicles following it in the chain
  *           if the wagon is dragged, don't delete the possibly belonging rear-engine to some front
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSellRailWagon(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	/* Check if we deleted a vehicle window */
 	Window *w = NULL;
@@ @@ -1994,12 +2000,14 @@ static void ReverseTrainDirection(Train @@
 /** Reverse train.
  * @param tile unused
  * @param flags type of operation
  * @param p1 train to reverse
  * @param p2 if true, reverse a unit in a train (needs to be in a depot)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdReverseTrainDirection(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Train *v = Train::GetIfValid(p1);
 	if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
@@ @@ -2052,12 +2060,14 @@ CommandCost CmdReverseTrainDirection(Til @@
 /** Force a train through a red signal
  * @param tile unused
  * @param flags type of operation
  * @param p1 train to ignore the red signal
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdForceTrainProceed(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Train *t = Train::GetIfValid(p1);
 	if (t == NULL || !CheckOwnership(t->owner)) return CMD_ERROR;
@@ @@ -2067,17 +2077,18 @@ CommandCost CmdForceTrainProceed(TileInd @@
+}
 /** Refits a train to the specified cargo type.
  * @param tile unused
  * @param flags type of operation
  * @param p1 vehicle ID of the train to refit
  * param p2 various bitstuffed elements
+ * @param p2 various bitstuffed elements
  * - p2 = (bit 0-7) - the new cargo type to refit to
  * - p2 = (bit 8-15) - the new cargo subtype to refit to
  * - p2 = (bit 16) - refit only this vehicle
  * @return cost of refit or error
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdRefitRailVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CargoID new_cid = GB(p2, 0, 8);
 	byte new_subtype = GB(p2, 8, 8);
 	bool only_this = HasBit(p2, 16);
@@ @@ -2274,12 +2285,14 @@ bool Train::FindClosestDepot(TileIndex * @@
  * @param tile unused
  * @param flags type of operation
  * @param p1 train to send to the depot
  * @param p2 various bitmasked elements
  * - p2 bit 0-3 - DEPOT_ flags (see vehicle.h)
  * - p2 bit 8-10 - VLW flag (for mass goto depot)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSendTrainToDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (p2 & DEPOT_MASS_SEND) {
 		/* Mass goto depot requested */
 		if (!ValidVLWFlags(p2 & VLW_MASK)) return CMD_ERROR;

src/tree_cmd.cpp

➞

Show inline comments

@@ @@ -325,12 +325,14 @@ void GenerateTrees() @@
 /** Plant a tree.
  * @param tile start tile of area-drag of tree plantation
  * @param flags type of operation
  * @param p1 tree type, -1 means random.
  * @param p2 end tile of area-drag
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdPlantTree(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	StringID msg = INVALID_STRING_ID;
 	CommandCost cost(EXPENSES_OTHER);
 	int ex;

src/tunnelbridge_cmd.cpp

➞

Show inline comments

@@ @@ -180,12 +180,14 @@ bool CheckBridge_Stuff(BridgeType bridge @@
  * @param flags type of operation
  * @param p1 packed start tile coords (~ dx)
  * @param p2 various bitstuffed elements
  * - p2 = (bit  0- 7) - bridge type (hi bh)
  * - p2 = (bit  8-14) - rail type or road types.
  * - p2 = (bit 15-16) - transport type.
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildBridge(TileIndex end_tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	RailType railtype = INVALID_RAILTYPE;
 	RoadTypes roadtypes = ROADTYPES_NONE;
 	CommandCost cost(EXPENSES_CONSTRUCTION);
@@ @@ -449,12 +451,14 @@ CommandCost CmdBuildBridge(TileIndex end @@
 /** Build Tunnel.
  * @param start_tile start tile of tunnel
  * @param flags type of operation
  * @param p1 railtype or roadtypes. bit 9 set means road tunnel
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildTunnel(TileIndex start_tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	TransportType transport_type = (TransportType)GB(p1, 9, 1);
 	CommandCost cost(EXPENSES_CONSTRUCTION);

src/unmovable_cmd.cpp

➞

Show inline comments

@@ @@ -103,12 +103,14 @@ extern CommandCost CheckFlatLandBelow(Ti @@
 /** Build or relocate the HQ. This depends if the HQ is already built or not
  * @param tile tile where the HQ will be built or relocated to
  * @param flags type of operation
  * @param p1 unused
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildCompanyHQ(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Company *c = Company::Get(_current_company);
 	CommandCost cost(EXPENSES_PROPERTY);
@@ @@ -136,13 +138,14 @@ CommandCost CmdBuildCompanyHQ(TileIndex @@
 /** Purchase a land area. Actually you only purchase one tile, so
  * the name is a bit confusing ;p
  * @param tile the tile the company is purchasing
  * @param flags for this command type
  * @param p1 unused
  * @param p2 unused
  * @return error of cost of operation
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdPurchaseLandArea(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost(EXPENSES_CONSTRUCTION);
 	if (IsOwnedLandTile(tile) && IsTileOwner(tile, _current_company)) {
@@ @@ -163,13 +166,14 @@ CommandCost CmdPurchaseLandArea(TileInde @@
 /** Sell a land area. Actually you only sell one tile, so
  * the name is a bit confusing ;p
  * @param tile the tile the company is selling
  * @param flags for this command type
  * @param p1 unused
  * @param p2 unused
  * @return error or cost of operation
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdSellLandArea(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (!IsOwnedLandTile(tile)) return CMD_ERROR;
 	if (!CheckTileOwnership(tile) && _current_company != OWNER_WATER) return CMD_ERROR;

src/vehicle_cmd.cpp

➞

Show inline comments

@@ @@ -62,13 +62,14 @@ const uint32 _send_to_depot_proc_table[] @@
 /** Start/Stop a vehicle
  * @param tile unused
  * @param flags type of operation
  * @param p1 vehicle to start/stop
  * @param p2 bit 0: Shall the start/stop newgrf callback be evaluated (only valid with DC_AUTOREPLACE for network safety)
  * @return result of operation.  Nothing if everything went well
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	/* Disable the effect of p2 bit 0, when DC_AUTOREPLACE is not set */
 	if ((flags & DC_AUTOREPLACE) == 0) SetBit(p2, 0);
@@ @@ -119,12 +120,14 @@ CommandCost CmdStartStopVehicle(TileInde @@
  * @param p1 Station/Order/Depot ID (only used for vehicle list windows)
  * @param p2 bitmask
  *   - bit 0-4 Vehicle type
  *   - bit 5 false = start vehicles, true = stop vehicles
  *   - bit 6 if set, then it's a vehicle list window, not a depot and Tile is ignored in this case
  *   - bit 8-11 Vehicle List Window type (ignored unless bit 1 is set)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdMassStartStopVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleList list;
 	CommandCost return_value = CMD_ERROR;
 	VehicleType vehicle_type = (VehicleType)GB(p2, 0, 5);
@@ @@ -169,12 +172,14 @@ CommandCost CmdMassStartStopVehicle(Tile @@
 /** Sells all vehicles in a depot
  * @param tile Tile of the depot where the depot is
  * @param flags type of operation
  * @param p1 Vehicle type
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdDepotSellAllVehicles(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleList list;
 	CommandCost cost(EXPENSES_NEW_VEHICLES);
@@ @@ -198,12 +203,14 @@ CommandCost CmdDepotSellAllVehicles(Tile @@
  * Luckily the final price can only drop, not increase. This is due to the fact that
  * estimation can't predict wagon removal so it presumes worst case which is no income from selling wagons.
  * @param tile Tile of the depot where the vehicles are
  * @param flags type of operation
  * @param p1 Type of vehicle
  * @param p2 If bit 0 is set, then either replace all or nothing (instead of replacing until money runs out)
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdDepotMassAutoReplace(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	VehicleList list;
 	CommandCost cost = CommandCost(EXPENSES_NEW_VEHICLES);
 	VehicleType vehicle_type = (VehicleType)GB(p1, 0, 8);
@@ @@ -311,12 +318,14 @@ static void CloneVehicleName(const Vehic @@
 /** Clone a vehicle. If it is a train, it will clone all the cars too
  * @param tile tile of the depot where the cloned vehicle is build
  * @param flags type of operation
  * @param p1 the original vehicle's index
  * @param p2 1 = shared orders, else copied orders
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdCloneVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost total_cost(EXPENSES_NEW_VEHICLES);
 	uint32 build_argument = 2;
@@ @@ -524,12 +533,14 @@ CommandCost SendAllVehiclesToDepot(Vehic @@
 /** Give a custom name to your vehicle
  * @param tile unused
  * @param flags type of operation
  * @param p1 vehicle ID to name
  * @param p2 unused
  * @param text the new name or an empty string when resetting to the default
  * @return the cost of this operation or an error
  */
 CommandCost CmdRenameVehicle(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Vehicle *v = Vehicle::GetIfValid(p1);
 	if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;
@@ @@ -553,12 +564,14 @@ CommandCost CmdRenameVehicle(TileIndex t @@
 /** Change the service interval of a vehicle
  * @param tile unused
  * @param flags type of operation
  * @param p1 vehicle ID that is being service-interval-changed
  * @param p2 new service interval
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdChangeServiceInt(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Vehicle *v = Vehicle::GetIfValid(p1);
 	if (v == NULL || !CheckOwnership(v->owner)) return CMD_ERROR;

src/water_cmd.cpp

➞

Show inline comments

@@ @@ -103,12 +103,14 @@ static void MarkCanalsAndRiversAroundDir @@
 /** Build a ship depot.
  * @param tile tile where ship depot is built
  * @param flags type of operation
  * @param p1 bit 0 depot orientation (Axis)
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildShipDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	TileIndex tile2;
 	CommandCost ret;
@@ @@ -267,12 +269,14 @@ static CommandCost RemoveShiplift(TileIn @@
 /** Builds a lock (ship-lift)
  * @param tile tile where to place the lock
  * @param flags type of operation
  * @param p1 unused
  * @param p2 unused
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildLock(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	DiagDirection dir = GetInclinedSlopeDirection(GetTileSlope(tile, NULL));
 	if (dir == INVALID_DIAGDIR) return_cmd_error(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
@@ @@ -284,12 +288,14 @@ CommandCost CmdBuildLock(TileIndex tile, @@
 /** Build a piece of canal.
  * @param tile end tile of stretch-dragging
  * @param flags type of operation
  * @param p1 start tile of stretch-dragging
  * @param p2 specifies canal (0), water (1) or river (2); last two can only be built in scenario editor
  * @param text unused
  * @return the cost of this operation or an error
  */
 CommandCost CmdBuildCanal(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	CommandCost cost(EXPENSES_CONSTRUCTION);
 	int size_x, size_y;
 	int x;

src/waypoint_cmd.cpp

➞

Show inline comments

@@ @@ -207,13 +207,13 @@ extern bool CanExpandRailStation(const B @@
  * - p1 = (bit 16-23) - height of waypoint
  * - p1 = (bit 24)    - allow waypoints directly adjacent to other waypoints.
  * @param p2 various bitstuffed elements
  * - p2 = (bit  0- 7) - custom station class
  * - p2 = (bit  8-15) - custom station id
  * @param text unused
  * @return cost of operation or error
+ * @return the cost of this operation or an error
  */
 CommandCost CmdBuildRailWaypoint(TileIndex start_tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	/* Unpack parameters */
 	Axis axis      = (Axis)GB(p1,  4, 1);
 	byte width     = GB(p1,  8, 8);
@@ @@ -327,13 +327,13 @@ CommandCost CmdBuildRailWaypoint(TileInd @@
 /** Build a buoy.
  * @param tile tile where to place the bouy
  * @param flags operation to perform
  * @param p1 unused
  * @param p2 unused
  * @param text unused
  * @return cost of operation or error
+ * @return the cost of this operation or an error
  */
 CommandCost CmdBuildBuoy(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (!IsWaterTile(tile) || tile == 0) return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
 	if (MayHaveBridgeAbove(tile) && IsBridgeAbove(tile)) return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
@@ @@ -424,14 +424,14 @@ static bool IsUniqueWaypointName(const c @@
 /**
  * Rename a waypoint.
  * @param tile unused
  * @param flags type of operation
  * @param p1 id of waypoint
  * @param p2 unused
  * @param text the new name of the waypoint or an empty string when resetting to the default
  * @return cost of operation or error
  * @param text the new name or an empty string when resetting to the default
  * @return the cost of this operation or an error
  */
 CommandCost CmdRenameWaypoint(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	Waypoint *wp = Waypoint::GetIfValid(p1);
 	if (wp == NULL || !(CheckOwnership(wp->owner) || wp->owner == OWNER_NONE)) return CMD_ERROR;

0 comments (0 inline, 0 general)