(svn r12505) [NoAI] -Documentation: still forgot some files ;) (minor stuff, capitals mostly)
--- a/src/ai/api/ai_airport.hpp.sq Mon Mar 31 08:42:20 2008 +0000
+++ b/src/ai/api/ai_airport.hpp.sq Mon Mar 31 08:45:05 2008 +0000
@@ -20,13 +20,13 @@
SQAIAirport.DefSQConst(engine, AIAirport::AT_SMALL, "AT_SMALL");
SQAIAirport.DefSQConst(engine, AIAirport::AT_LARGE, "AT_LARGE");
- SQAIAirport.DefSQConst(engine, AIAirport::AT_HELIPORT, "AT_HELIPORT");
SQAIAirport.DefSQConst(engine, AIAirport::AT_METROPOLITAN, "AT_METROPOLITAN");
SQAIAirport.DefSQConst(engine, AIAirport::AT_INTERNATIONAL, "AT_INTERNATIONAL");
SQAIAirport.DefSQConst(engine, AIAirport::AT_COMMUTER, "AT_COMMUTER");
+ SQAIAirport.DefSQConst(engine, AIAirport::AT_INTERCON, "AT_INTERCON");
+ SQAIAirport.DefSQConst(engine, AIAirport::AT_HELIPORT, "AT_HELIPORT");
+ SQAIAirport.DefSQConst(engine, AIAirport::AT_HELISTATION, "AT_HELISTATION");
SQAIAirport.DefSQConst(engine, AIAirport::AT_HELIDEPOT, "AT_HELIDEPOT");
- SQAIAirport.DefSQConst(engine, AIAirport::AT_INTERCON, "AT_INTERCON");
- SQAIAirport.DefSQConst(engine, AIAirport::AT_HELISTATION, "AT_HELISTATION");
SQAIAirport.DefSQStaticMethod(engine, &AIAirport::GetClassName, "GetClassName", 1, "x");
SQAIAirport.DefSQStaticMethod(engine, &AIAirport::IsHangarTile, "IsHangarTile", 2, "xi");
--- a/src/ai/api/ai_execmode.hpp Mon Mar 31 08:42:20 2008 +0000
+++ b/src/ai/api/ai_execmode.hpp Mon Mar 31 08:45:05 2008 +0000
@@ -31,7 +31,7 @@
public:
/**
* Creating instance of this class switches the build mode to Execute.
- * @note when the instance is destroyed, he restores the mode that was
+ * @note When the instance is destroyed, he restores the mode that was
* current when the instance was created!
*/
AIExecMode();
--- a/src/ai/api/ai_industry.hpp.sq Mon Mar 31 08:42:20 2008 +0000
+++ b/src/ai/api/ai_industry.hpp.sq Mon Mar 31 08:45:05 2008 +0000
@@ -21,9 +21,9 @@
SQAIIndustry.DefSQStaticMethod(engine, &AIIndustry::GetName, "GetName", 2, "xi");
SQAIIndustry.DefSQStaticMethod(engine, &AIIndustry::GetProduction, "GetProduction", 3, "xii");
SQAIIndustry.DefSQStaticMethod(engine, &AIIndustry::IsCargoAccepted, "IsCargoAccepted", 3, "xii");
- SQAIIndustry.DefSQStaticMethod(engine, &AIIndustry::GetLocation, "GetLocation", 2, "xi");
SQAIIndustry.DefSQStaticMethod(engine, &AIIndustry::GetLastMonthProduction, "GetLastMonthProduction", 3, "xii");
SQAIIndustry.DefSQStaticMethod(engine, &AIIndustry::GetLastMonthTransported, "GetLastMonthTransported", 3, "xii");
+ SQAIIndustry.DefSQStaticMethod(engine, &AIIndustry::GetLocation, "GetLocation", 2, "xi");
SQAIIndustry.DefSQStaticMethod(engine, &AIIndustry::GetDistanceManhattanToTile, "GetDistanceManhattanToTile", 3, "xii");
SQAIIndustry.DefSQStaticMethod(engine, &AIIndustry::GetDistanceSquareToTile, "GetDistanceSquareToTile", 3, "xii");
--- a/src/ai/api/ai_settings.hpp Mon Mar 31 08:42:20 2008 +0000
+++ b/src/ai/api/ai_settings.hpp Mon Mar 31 08:45:05 2008 +0000
@@ -20,8 +20,8 @@
* what ever delay the server has been programmed to delay commands
* (normally between 1 and 5). To give a more 'real' effect to your AI,
* you can control that number here.
- * @param ticks the minimum amount of ticks to wait.
- * @pre ticks should be positive. Too big values will influence performance of the AI.
+ * @param ticks The minimum amount of ticks to wait.
+ * @pre Ticks should be positive. Too big values will influence performance of the AI.
* @note If the number is lower then the MP setting, the MP setting wins.
*/
static void SetCommandDelay(uint ticks);
--- a/src/ai/api/ai_testmode.hpp Mon Mar 31 08:42:20 2008 +0000
+++ b/src/ai/api/ai_testmode.hpp Mon Mar 31 08:45:05 2008 +0000
@@ -33,7 +33,7 @@
public:
/**
* Creating instance of this class switches the build mode to Testing.
- * @note when the instance is destroyed, he restores the mode that was
+ * @note When the instance is destroyed, he restores the mode that was
* current when the instance was created!
*/
AITestMode();
--- a/src/ai/api/ai_tilelist.hpp Mon Mar 31 08:42:20 2008 +0000
+++ b/src/ai/api/ai_tilelist.hpp Mon Mar 31 08:45:05 2008 +0000
@@ -28,8 +28,8 @@
public:
/**
* Adds the rectangle between tile_from and tile_to to the to-be-evaluated tiles.
- * @param tile_from one corner of the tiles to add.
- * @param tile_to the other corner of the tiles to add.
+ * @param tile_from One corner of the tiles to add.
+ * @param tile_to The other corner of the tiles to add.
* @pre AIMap::IsValidTile(tile_from).
* @pre AIMap::IsValidTile(tile_to).
*/
@@ -37,15 +37,15 @@
/**
* Add a tile to the to-be-evaluated tiles.
- * @param tile the tile to add.
+ * @param tile The tile to add.
* @pre AIMap::IsValidTile(tile).
*/
void AddTile(TileIndex tile);
/**
* Remove the tiles inside the rectangle between tile_from and tile_to form the list.
- * @param tile_from one corner of the tiles to remove.
- * @param tile_to the other corner of the files to remove.
+ * @param tile_from One corner of the tiles to remove.
+ * @param tile_to The other corner of the files to remove.
* @pre AIMap::IsValidTile(tile_from).
* @pre AIMap::IsValidTile(tile_to).
*/
@@ -53,7 +53,7 @@
/**
* Remove a tile from the list.
- * @param tile the tile to remove.
+ * @param tile The tile to remove.
* @pre AIMap::IsValidTile(tile).
*/
void RemoveTile(TileIndex tile);
--- a/src/ai/api/ai_transactionmode.hpp Mon Mar 31 08:42:20 2008 +0000
+++ b/src/ai/api/ai_transactionmode.hpp Mon Mar 31 08:45:05 2008 +0000
@@ -49,7 +49,7 @@
public:
/**
* Creating instance of this class switches the build mode to Transaction.
- * @note when the instance is destroyed, he restores the mode that was
+ * @note When the instance is destroyed, he restores the mode that was
* current when the instance was created!
*/
AITransactionMode();
@@ -62,9 +62,9 @@
/**
* Execute all recorded commands.
- * @return false if any command recorded failed to execute. All other
+ * @return False if any command recorded failed to execute. All other
* commands that follow won't be executed either.
- * @note when Execute() is called, the transaction is stopped (like calling
+ * @note When Execute() is called, the transaction is stopped (like calling
* Stop() yourself).
* @note Execute() is always executed, no matter what mode you gave it in
* the outside world. It forces itself into executing it for real. To add
@@ -85,9 +85,9 @@
* It rolls back all commands by looking up the reverse of every command
* issued and executes that. Of course it can happen that even that fails.
* In that case the problem will be silently ignored.
- * @note as you might want to get a costs estimate about the rollback first
+ * @note As you might want to get a costs estimate about the rollback first
* you need to make sure you set the right mode yourself!
- * @note this command isn't finished yet!!
+ * @note This command isn't finished yet!!
*/
void Rollback();
@@ -99,7 +99,7 @@
/**
* Append one transaction list to an other.
- * @param transaction the list that will be appended after the instance you call append on.
+ * @param transaction The list that will be appended after the instance you call append on.
*/
void Append(AITransactionMode *transaction);
};