dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r20499) -Doc: Spelling fixes, and one doxygen comment addition.

Browse Source
This commit is contained in:
alberth
2010-08-15 14:06:43 +00:00
parent 15514baf8b
commit 35fec79700
12 changed files with 50 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/ai/ai_instance.hpp
View File

@@ -30,7 +30,7 @@ public:
{}
/**
* Get the amount ot ticks the AI should be suspended.
* Get the amount of ticks the AI should be suspended.
* @return The amount of AI ticks to suspend the AI.
*/
int GetSuspendTime() { return time; }
@@ -172,7 +172,7 @@ private:
void RegisterAPI();
/**
* Load squirrel scipts to emulate an older API.
* Load squirrel scripts to emulate an older API.
*/
bool LoadCompatibilityScripts(const char *api_version);
@@ -182,7 +182,7 @@ private:
void Died();
/**
* Save one object (int / string / arrray / table) to the savegame.
* Save one object (int / string / array / table) to the savegame.
* @param vm The virtual machine to get all the data from.
* @param index The index on the squirrel stack of the element to save.
* @param max_depth The maximum depth recursive arrays / tables will be stored

10
src/ai/api/ai_base.hpp
View File

@@ -36,7 +36,7 @@ public:
/**
* Get a random value.
* @param unused_param This param is not used, but is needed to work with lists.
* @param unused_param This parameter is not used, but is needed to work with lists.
* @return A random value between 0 and MAX(uint32).
*/
static uint32 RandItem(int unused_param);
@@ -50,14 +50,14 @@ public:
/**
* Get a random value in a range.
* @param unused_param This param is not used, but is needed to work with lists.
* @param unused_param This parameter is not used, but is needed to work with lists.
* @param max The first number this function will never return (the maximum it returns is max - 1).
* @return A random value between 0 .. max - 1.
*/
static uint RandRangeItem(int unused_param, uint max);
/**
* Returns approximatelly 'out' times true when called 'max' times.
* Returns approximately 'out' times true when called 'max' times.
* After all, it is a random function.
* @param out How many times it should return true.
* @param max Out of this many times.
@@ -66,9 +66,9 @@ public:
static bool Chance(uint out, uint max);
/**
* Returns approximatelly 'out' times true when called 'max' times.
* Returns approximately 'out' times true when called 'max' times.
* After all, it is a random function.
* @param unused_param This param is not used, but is needed to work with lists.
* @param unused_param This parameter is not used, but is needed to work with lists.
* @param out How many times it should return true.
* @param max Out of this many times.
* @return True if the chance worked out.