(svn r20266) -Doc: Mostly typo fixes, a few doxygen-related improvements.
This commit is contained in:
@@ -93,7 +93,7 @@ public:
|
||||
* @param gender The new gender for your president.
|
||||
* @pre GetPresidentGender(AICompany.COMPANY_SELF) != gender.
|
||||
* @return True if the gender was changed.
|
||||
* @note When succesfull a random face will be created.
|
||||
* @note When successful a random face will be created.
|
||||
*/
|
||||
static bool SetPresidentGender(Gender gender);
|
||||
|
||||
|
@@ -76,7 +76,7 @@ public:
|
||||
enum ErrorMessages {
|
||||
/** Initial error value */
|
||||
ERR_NONE = ERR_CAT_NONE << ERR_CAT_BIT_SIZE, // []
|
||||
/** If an error occured and the error wasn't mapped */
|
||||
/** If an error occurred and the error wasn't mapped */
|
||||
ERR_UNKNOWN, // []
|
||||
/** If a precondition is not met */
|
||||
ERR_PRECONDITION_FAILED, // []
|
||||
|
@@ -54,7 +54,7 @@ public:
|
||||
* given group will move to the GROUP_DEFAULT.
|
||||
* @param group_id The group to delete.
|
||||
* @pre IsValidGroup(group_id).
|
||||
* @return True if and only if the group was succesfully deleted.
|
||||
* @return True if and only if the group was successfully deleted.
|
||||
*/
|
||||
static bool DeleteGroup(GroupID group_id);
|
||||
|
||||
@@ -92,7 +92,7 @@ public:
|
||||
* @param group_id The group to change the protection for.
|
||||
* @param enable True if protection should be enabled.
|
||||
* @pre IsValidGroup(group_id).
|
||||
* @return True if and only if the protection was succesfully changed.
|
||||
* @return True if and only if the protection was successfully changed.
|
||||
*/
|
||||
static bool EnableAutoReplaceProtection(GroupID group_id, bool enable);
|
||||
|
||||
@@ -119,7 +119,7 @@ public:
|
||||
* @param vehicle_id The vehicle to move to the group.
|
||||
* @pre IsValidGroup(group_id) || group_id == GROUP_DEFAULT.
|
||||
* @pre AIVehicle::IsValidVehicle(vehicle_id).
|
||||
* @return True if and only if the vehicle was succesfully moved to the group.
|
||||
* @return True if and only if the vehicle was successfully moved to the group.
|
||||
* @note A vehicle can be in only one group at the same time. To remove it from
|
||||
* a group, move it to another or to GROUP_DEFAULT. Moving the vehicle to the
|
||||
* given group means removing it from another group.
|
||||
@@ -132,7 +132,7 @@ public:
|
||||
* If enabled, wagons are removed from the end of the vehicle until it
|
||||
* fits in the same number of tiles as it did before.
|
||||
* @param keep_length If true, wagons will be removed if the a new engine is longer.
|
||||
* @return True if and only if the value was succesfully changed.
|
||||
* @return True if and only if the value was successfully changed.
|
||||
*/
|
||||
static bool EnableWagonRemoval(bool keep_length);
|
||||
|
||||
@@ -169,7 +169,7 @@ public:
|
||||
* @param group_id The group to stop replacing the engine in.
|
||||
* @param engine_id The engine id to stop replacing with another engine.
|
||||
* @pre IsValidGroup(group_id) || group_id == GROUP_DEFAULT || group_id == GROUP_ALL.
|
||||
* @return True if and if the replacing was succesfully stopped.
|
||||
* @return True if and if the replacing was successfully stopped.
|
||||
*/
|
||||
static bool StopAutoReplace(GroupID group_id, EngineID engine_id);
|
||||
};
|
||||
|
@@ -114,7 +114,7 @@ public:
|
||||
* @param industry_type The type of the industry to build.
|
||||
* @param tile The tile to build the industry on.
|
||||
* @pre CanBuildIndustry(industry_type).
|
||||
* @return True if the industry was succesfully build.
|
||||
* @return True if the industry was successfully build.
|
||||
*/
|
||||
static bool BuildIndustry(IndustryType industry_type, TileIndex tile);
|
||||
|
||||
@@ -123,7 +123,7 @@ public:
|
||||
* an industry on a random place on the map.
|
||||
* @param industry_type The type of the industry.
|
||||
* @pre CanProspectIndustry(industry_type).
|
||||
* @return True if no error occured while trying to prospect.
|
||||
* @return True if no error occurred while trying to prospect.
|
||||
* @note Even if true is returned there is no guarantee a new industry is build.
|
||||
* @note If true is returned the money is paid, whether a new industry was build or not.
|
||||
*/
|
||||
|
@@ -194,7 +194,7 @@ public:
|
||||
* @pre AIMap::IsValidTile(end_tile).
|
||||
* @pre IsRailTypeAvailable(convert_to).
|
||||
* @exception AIRail::ERR_UNSUITABLE_TRACK
|
||||
* @return Whether at least some rail has been converted succesfully.
|
||||
* @return Whether at least some rail has been converted successfully.
|
||||
*/
|
||||
static bool ConvertRailType(TileIndex start_tile, TileIndex end_tile, AIRail::RailType convert_to);
|
||||
|
||||
|
@@ -398,7 +398,7 @@ public:
|
||||
* @exception AIError::ERR_TOO_CLOSE_TO_EDGE
|
||||
* @return True if one or more tiles were leveled.
|
||||
* @note Even if leveling some part fails, some other part may have been
|
||||
* succesfully leveled already.
|
||||
* successfully leveled already.
|
||||
* @note This function may return true in AITestMode, although it fails in
|
||||
* AIExecMode.
|
||||
*/
|
||||
|
Reference in New Issue
Block a user