Changeset - r17632:92f095eb81a2
[Not reviewed]
master
0 15 0
rubidium - 14 years ago 2011-05-02 20:59:54
rubidium@openttd.org
(svn r22413) -Document: even more stuff
15 files changed with 78 insertions and 6 deletions:
0 comments (0 inline, 0 general)
src/airport.cpp
Show inline comments
 
@@ -16,6 +16,14 @@
 
#include "table/airporttile_ids.h"
 

	
 

	
 
/**
 
 * Define a generic airport.
 
 * @param name Suffix of the names of the airport data.
 
 * @param terminals The terminals.
 
 * @param num_helipads Number of heli pads.
 
 * @param flags Information about the class of FTA.
 
 * @param delta_z Height of the arport above the land.
 
 */
 
#define AIRPORT_GENERIC(name, terminals, num_helipads, flags, delta_z) \
 
	static AirportFTAClass _airportfta_ ## name(_airport_moving_data_ ## name, terminals, \
 
			num_helipads, _airport_entries_ ## name, flags, _airport_fta_ ## name, delta_z);
 
@@ -154,7 +162,12 @@ static uint16 AirportGetNofElements(cons
 
	return nofelements;
 
}
 

	
 

	
 
/**
 
 * Construct the FTA given a description.
 
 * @param nofelements The number of elements in the FTA.
 
 * @param apFA The description of the FTA.
 
 * @return The FTA describing the airport.
 
 */
 
static AirportFTA *AirportBuildAutomata(uint nofelements, const AirportFTAbuildup *apFA)
 
{
 
	AirportFTA *FAutomata = MallocT<AirportFTA>(nofelements);
src/articulated_vehicles.cpp
Show inline comments
 
@@ -40,6 +40,12 @@ static EngineID GetNextArticulatedPart(u
 
	return GetNewEngineID(GetEngineGRF(front_type), Engine::Get(front_type)->type, GB(callback, 0, 7));
 
}
 

	
 
/**
 
 * Count the number of articulated parts of an engine.
 
 * @param engine_type The engine to get the number of parts of.
 
 * @param purchase_window Whether we are in the scope of the purchase window or not, i.e. whether we cannot allocate vehicles.
 
 * @return The nmumber of parts.
 
 */
 
uint CountArticulatedParts(EngineID engine_type, bool purchase_window)
 
{
 
	if (!HasBit(EngInfo(engine_type)->callback_mask, CBM_VEHICLE_ARTIC_ENGINE)) return 0;
 
@@ -101,6 +107,11 @@ static inline uint32 GetAvailableVehicle
 
	return cargos;
 
}
 

	
 
/**
 
 * Get the capacity of the parts of a given engine.
 
 * @param engine The engine to get the capacities from.
 
 * @return The cargo capacities.
 
 */
 
CargoArray GetCapacityOfArticulatedParts(EngineID engine)
 
{
 
	CargoArray capacity;
 
@@ -276,6 +287,10 @@ void CheckConsistencyOfArticulatedVehicl
 
	}
 
}
 

	
 
/**
 
 * Add the remaining articulated parts to the given vehicle.
 
 * @param first The head of the articulated bit.
 
 */
 
void AddArticulatedParts(Vehicle *first)
 
{
 
	VehicleType type = first->type;
src/autoreplace.cpp
Show inline comments
 
@@ -15,6 +15,7 @@
 
#include "autoreplace_base.h"
 
#include "core/pool_func.hpp"
 

	
 
/** The pool of autoreplace "orders". */
 
EngineRenewPool _enginerenew_pool("EngineRenew");
 
INSTANTIATE_POOL_METHODS(EngineRenew)
 

	
src/autoreplace_gui.cpp
Show inline comments
 
@@ -579,6 +579,11 @@ static const WindowDesc _replace_vehicle
 
	_nested_replace_vehicle_widgets, lengthof(_nested_replace_vehicle_widgets)
 
);
 

	
 
/**
 
 * Show the autoreplace configuration window for a particular group.
 
 * @param id_g The group to replace the vehicles for.
 
 * @param vehicletype The type of vehicles in the group.
 
 */
 
void ShowReplaceGroupVehicleWindow(GroupID id_g, VehicleType vehicletype)
 
{
 
	DeleteWindowById(WC_REPLACE_VEHICLE, vehicletype);
src/base_media_func.h
Show inline comments
 
@@ -274,6 +274,12 @@ template <class Tbase_set>
 
#if defined(ENABLE_NETWORK)
 
#include "network/network_content.h"
 

	
 
/**
 
 * Check whether there's a base set matching some information.
 
 * @param ci The content info to compare it to.
 
 * @param md5sum Should the MD5 checksum be tested as well?
 
 * @param s The list with sets.
 
 */
 
template <class Tbase_set> bool HasBaseSet(const ContentInfo *ci, bool md5sum, const Tbase_set *s)
 
{
 
	for (; s != NULL; s = s->next) {
src/bridge.h
Show inline comments
 
@@ -59,6 +59,11 @@ extern BridgeSpec _bridge[MAX_BRIDGES];
 
Foundation GetBridgeFoundation(Slope tileh, Axis axis);
 
bool HasBridgeFlatRamp(Slope tileh, Axis axis);
 

	
 
/**
 
 * Get the specification of a bridge type.
 
 * @param i The type of bridge to get the specification for.
 
 * @return The specification.
 
 */
 
static inline const BridgeSpec *GetBridgeSpec(BridgeType i)
 
{
 
	assert(i < lengthof(_bridge));
src/cargo_type.h
Show inline comments
 
@@ -113,7 +113,7 @@ enum SourceType {
 
	ST_TOWN,         ///< Source/destination is a town
 
	ST_HEADQUARTERS, ///< Source/destination are company headquarters
 
};
 
typedef SimpleTinyEnumT<SourceType, byte> SourceTypeByte;
 
typedef SimpleTinyEnumT<SourceType, byte> SourceTypeByte; ///< The SourceType packed into a byte for savegame purposes.
 

	
 
typedef uint16 SourceID; ///< Contains either industry ID, town ID or company ID (or INVALID_SOURCE)
 
static const SourceID INVALID_SOURCE = 0xFFFF; ///< Invalid/unknown index of source
src/cargopacket.cpp
Show inline comments
 
@@ -246,7 +246,7 @@ void CargoList<Tinst>::Truncate(uint max
 
 *  - MTA_TRANSFER:       Just move without side effects.
 
 *  - MTA_UNLOAD:         Just move without side effects.
 
 * @param dest  Destination to move the cargo to.
 
 * @param count Amount of cargo entities to move.
 
 * @param max_move Amount of cargo entities to move.
 
 * @param mta   How to handle the moving (side effects).
 
 * @param data  Depending on mta the data of this variable differs:
 
 *              - MTA_FINAL_DELIVERY - Station ID of packet's origin not to remove.
src/cheat.cpp
Show inline comments
 
@@ -12,8 +12,10 @@
 
#include "stdafx.h"
 
#include "cheat_type.h"
 

	
 
/** All the cheats. */
 
Cheats _cheats;
 

	
 
/** Reinitialise all the cheats. */
 
void InitializeCheats()
 
{
 
	memset(&_cheats, 0, sizeof(Cheats));
src/clear_map.h
Show inline comments
 
@@ -310,6 +310,7 @@ static inline void MakeField(TileIndex t
 
/**
 
 * Make a snow tile.
 
 * @param t the tile to make snowy
 
 * @param density The density of snowiness.
 
 * @pre GetClearGround(t) != CLEAR_SNOW
 
 */
 
static inline void MakeSnow(TileIndex t, uint density = 0)
src/company_cmd.cpp
Show inline comments
 
@@ -393,7 +393,9 @@ bad_town_name:;
 
	}
 
}
 

	
 
/** Sorting weights for the company colours. */
 
static const byte _colour_sort[COLOUR_END] = {2, 2, 3, 2, 3, 2, 3, 2, 3, 2, 2, 2, 3, 1, 1, 1};
 
/** Similar colours, so we can try to prevent same coloured companies. */
 
static const Colours _similar_colour[COLOUR_END][2] = {
 
	{ COLOUR_BLUE,       COLOUR_LIGHT_BLUE }, // COLOUR_DARK_BLUE
 
	{ COLOUR_GREEN,      COLOUR_DARK_GREEN }, // COLOUR_PALE_GREEN
 
@@ -685,6 +687,7 @@ static void HandleBankruptcyTakeover(Com
 
	}
 
}
 

	
 
/** Called every tick for updating some company info. */
 
void OnTick_Companies()
 
{
 
	if (_game_mode == GM_EDITOR) return;
src/company_gui.cpp
Show inline comments
 
@@ -2068,6 +2068,10 @@ static const WindowDesc _company_desc(
 
	_nested_company_widgets, lengthof(_nested_company_widgets)
 
);
 

	
 
/**
 
 * Show the window with the overview of the company.
 
 * @param company The company to show the window for.
 
 */
 
void ShowCompany(CompanyID company)
 
{
 
	if (!Company::IsValidID(company)) return;
 
@@ -2175,7 +2179,10 @@ static const WindowDesc _buy_company_des
 
	_nested_buy_company_widgets, lengthof(_nested_buy_company_widgets)
 
);
 

	
 

	
 
/**
 
 * Show the query to buy another company.
 
 * @param company The company to buy.
 
 */
 
void ShowBuyCompanyDialog(CompanyID company)
 
{
 
	AllocateWindowDescFront<BuyCompanyWindow>(&_buy_company_desc, company);
src/company_manager_face.h
Show inline comments
 
@@ -84,6 +84,7 @@ static const CompanyManagerFaceBitsInfo 
 
	/* CMFV_TIE_EARRING     */ { 28, 3, {  6,  3,  6,  3 }, { 0x372, 0x37F, 0x372, 0x3D1 } }, ///< Depends on CMFV_HAS_TIE_EARRING
 
	/* CMFV_GLASSES         */ { 31, 1, {  2,  2,  2,  2 }, { 0x347, 0x347, 0x3AE, 0x3AE } }  ///< Depends on CMFV_HAS_GLASSES
 
};
 
/** Make sure the table's size is right. */
 
assert_compile(lengthof(_cmf_info) == CMFV_END);
 

	
 
/**
src/economy.cpp
Show inline comments
 
@@ -281,7 +281,11 @@ int UpdateCompanyRatingAndValue(Company 
 
	return score;
 
}
 

	
 
/*  use INVALID_OWNER as new_owner to delete the company. */
 
/**
 
 * Change the ownership of all the items of a company.
 
 * @param old_owner The company that gets removed.
 
 * @param new_owner The company to merge to, or INVALID_OWNER to remove the company.
 
 */
 
void ChangeOwnershipOfCompanyItems(Owner old_owner, Owner new_owner)
 
{
 
	/* We need to set _current_company to old_owner before we try to move
src/tunnelbridge_cmd.cpp
Show inline comments
 
@@ -89,6 +89,12 @@ int CalcBridgeLenCostFactor(int length)
 
	}
 
}
 

	
 
/**
 
 * Get the foundation for a bridge.
 
 * @param tileh The slope to build the bridge on.
 
 * @param axis The axis of the bridge entrace.
 
 * @return The foundatiton required.
 
 */
 
Foundation GetBridgeFoundation(Slope tileh, Axis axis)
 
{
 
	if (tileh == SLOPE_FLAT ||
 
@@ -1208,7 +1214,10 @@ static BridgePieces CalcBridgePiece(uint
 
	}
 
}
 

	
 

	
 
/**
 
 * Draw the middle bits of a bridge.
 
 * @param ti Tile information of the tile to draw it on.
 
 */
 
void DrawBridgeMiddle(const TileInfo *ti)
 
{
 
	/* Sectional view of bridge bounding boxes:
0 comments (0 inline, 0 general)