(svn r25924) -Fix: [Script] Documentation for ScriptTown::GetGrowthRate.

This commit is contained in:
frosch 2013-10-28 11:09:02 +00:00
parent 28f6009509
commit a249db1374
2 changed files with 2 additions and 2 deletions

View File

@ -166,7 +166,7 @@
/* static */ int32 ScriptTown::GetGrowthRate(TownID town_id) /* static */ int32 ScriptTown::GetGrowthRate(TownID town_id)
{ {
if (!IsValidTown(town_id)) return false; if (!IsValidTown(town_id)) return -1;
const Town *t = ::Town::Get(town_id); const Town *t = ::Town::Get(town_id);

View File

@ -262,7 +262,7 @@ public:
* Get the amount of days between town growth. * Get the amount of days between town growth.
* @param town_id The index of the town. * @param town_id The index of the town.
* @pre IsValidTown(town_id). * @pre IsValidTown(town_id).
* @return True if the action succeeded. * @return Amount of days between town growth.
* @note This function does not indicate when it will grow next. It only tells you the time between growths. * @note This function does not indicate when it will grow next. It only tells you the time between growths.
*/ */
static int32 GetGrowthRate(TownID town_id); static int32 GetGrowthRate(TownID town_id);