mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r23299) -Codechange: remove silly comments from AI documentation

release/1.2
truebrain 2011-11-23 16:05:59 +00:00
parent 229e572663
commit 68b133c110
3 changed files with 0 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/ai/api/ai_company.hpp
View File

@ -131,7 +131,6 @@ public:
/**
* Gets the amount your company have loaned.
* @return The amount loaned money.
* @post The return value is always non-negative.
* @post GetLoanInterval() is always a multiplier of the return value.
*/
static Money GetLoanAmount();
@ -139,7 +138,6 @@ public:
/**
* Gets the maximum amount your company can loan.
* @return The maximum amount your company can loan.
* @post The return value is always non-negative.
* @post GetLoanInterval() is always a multiplier of the return value.
*/
static Money GetMaxLoanAmount();

1
src/ai/api/ai_industry.hpp
View File

@ -29,7 +29,6 @@ public:
/**
* Gets the number of industries.
* @return The number of industries.
* @post Return value is always non-negative.
* @note The maximum valid IndustryID can be higher than the value returned.
*/
static int32 GetIndustryCount();

7
src/ai/api/ai_town.hpp
View File

@ -104,7 +104,6 @@ public:
/**
* Gets the number of towns.
* @return The number of towns.
* @post Return value is always non-negative.
*/
static int32 GetTownCount();
@ -128,7 +127,6 @@ public:
* @param town_id The town to get the population of.
* @pre IsValidTown(town_id).
* @return The number of inhabitants.
* @post Return value is always non-negative.
*/
static int32 GetPopulation(TownID town_id);
@ -137,7 +135,6 @@ public:
* @param town_id The town to get the number of houses of.
* @pre IsValidTown(town_id).
* @return The number of houses.
* @post Return value is always non-negative.
*/
static int32 GetHouseCount(TownID town_id);
@ -156,7 +153,6 @@ public:
* @pre IsValidTown(town_id).
* @pre AICargo::IsValidCargo(cargo_id).
* @return The last month's production of the given cargo for this town.
* @post Return value is always non-negative.
*/
static int32 GetLastMonthProduction(TownID town_id, CargoID cargo_id);
@ -167,7 +163,6 @@ public:
* @pre IsValidTown(town_id).
* @pre AICargo::IsValidCargo(cargo_id).
* @return The amount of cargo supplied for transport from this town last month.
* @post Return value is always non-negative.
*/
static int32 GetLastMonthSupplied(TownID town_id, CargoID cargo_id);
@ -178,7 +173,6 @@ public:
* @pre IsValidTown(town_id).
* @pre AICargo::IsValidCargo(cargo_id).
* @return The percentage of given cargo transported from this town last month.
* @post Return value is always non-negative.
*/
static int32 GetLastMonthTransportedPercentage(TownID town_id, CargoID cargo_id);
@ -189,7 +183,6 @@ public:
* @pre IsValidTown(town_id).
* @pre AICargo::IsValidTownEffect(cargo_id).
* @return The amount of cargo received by this town last month for this cargo effect.
* @post Return value is always non-negative.
*/
static int32 GetLastMonthReceived(TownID town_id, AICargo::TownEffect towneffect_id);