Mercurial > hg > openttd
changeset 18455:06a745446588 draft
(svn r23299) -Codechange: remove silly comments from AI documentation
| author | truebrain <truebrain@openttd.org> |
|---|---|
| date | Wed, 23 Nov 2011 16:05:59 +0000 |
| parents | b9e554b1d8a1 |
| children | 83ceb002c6df |
| files | src/ai/api/ai_company.hpp src/ai/api/ai_industry.hpp src/ai/api/ai_town.hpp |
| diffstat | 3 files changed, 0 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/src/ai/api/ai_company.hpp +++ b/src/ai/api/ai_company.hpp @@ -131,7 +131,6 @@ /** * 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 @@ /** * 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();
--- a/src/ai/api/ai_industry.hpp +++ b/src/ai/api/ai_industry.hpp @@ -29,7 +29,6 @@ /** * 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();
--- a/src/ai/api/ai_town.hpp +++ b/src/ai/api/ai_town.hpp @@ -104,7 +104,6 @@ /** * Gets the number of towns. * @return The number of towns. - * @post Return value is always non-negative. */ static int32 GetTownCount(); @@ -128,7 +127,6 @@ * @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 @@ * @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 @@ * @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 @@ * @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 @@ * @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 @@ * @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);