summaryrefslogtreecommitdiff
path: root/src/ai
diff options
context:
space:
mode:
authortruebrain <truebrain@openttd.org>2011-11-23 16:05:59 +0000
committertruebrain <truebrain@openttd.org>2011-11-23 16:05:59 +0000
commit68b133c110fe18b3927e7a06a748d6b6ef4c2838 (patch)
treebe3b58d3f55ff77b836de0e0af56cb098784bb86 /src/ai
parent229e572663158d8fd37cabf3c2a3cb06811ff0a1 (diff)
downloadopenttd-68b133c110fe18b3927e7a06a748d6b6ef4c2838.tar.xz
(svn r23299) -Codechange: remove silly comments from AI documentation
Diffstat (limited to 'src/ai')
-rw-r--r--src/ai/api/ai_company.hpp2
-rw-r--r--src/ai/api/ai_industry.hpp1
-rw-r--r--src/ai/api/ai_town.hpp7
3 files changed, 0 insertions, 10 deletions
diff --git a/src/ai/api/ai_company.hpp b/src/ai/api/ai_company.hpp
index 4980f0ebc..6a5d64d5d 100644
--- a/src/ai/api/ai_company.hpp
+++ b/src/ai/api/ai_company.hpp
@@ -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();
diff --git a/src/ai/api/ai_industry.hpp b/src/ai/api/ai_industry.hpp
index 4ffdf42fc..a5513e453 100644
--- a/src/ai/api/ai_industry.hpp
+++ b/src/ai/api/ai_industry.hpp
@@ -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();
diff --git a/src/ai/api/ai_town.hpp b/src/ai/api/ai_town.hpp
index 9ad4b24c1..da86d5994 100644
--- a/src/ai/api/ai_town.hpp
+++ b/src/ai/api/ai_town.hpp
@@ -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);