Changeset - r11135:69653d8e8522
[Not reviewed]
master
0 2 0
yexo - 15 years ago 2009-02-14 20:07:05
yexo@openttd.org
(svn r15482) -Fix [NoAI]: Typos in api docs.
2 files changed with 3 insertions and 3 deletions:
0 comments (0 inline, 0 general)
src/ai/api/ai_company.hpp
Show inline comments
 
@@ -89,25 +89,25 @@ public:
 
	static char *GetPresidentName(CompanyID company);
 

	
 
	/**
 
	 * Sets the amount to loan.
 
	 * @param loan The amount to loan (multiplier of GetLoanInterval()).
 
	 * @pre 'loan' must be non-negative.
 
	 * @pre GetLoanInterval() must be a multiplier of GetLoanInterval().
 
	 * @pre GetLoanInterval() must be a multiplier of 'loan'.
 
	 * @pre 'loan' must be below GetMaxLoanAmount().
 
	 * @pre 'loan' - GetLoanAmount() + GetBankBalance() must be non-negative.
 
	 * @return True if the loan could be set to your requested amount.
 
	 */
 
	static bool SetLoanAmount(int32 loan);
 

	
 
	/**
 
	 * Sets the minimum amount to loan, i.e. the given amount of loan rounded up.
 
	 * @param loan The amount to loan (any positive number).
 
	 * @pre 'loan' must be non-negative.
 
	 * @pre 'loan' must be below GetMaxLoanAmount().
 
	 * @return True if we could allocate a minimum of "loan" loan.
 
	 * @return True if we could allocate a minimum of 'loan' loan.
 
	 */
 
	static bool SetMinimumLoanAmount(int32 loan);
 

	
 
	/**
 
	 * Gets the amount your company have loaned.
 
	 * @return The amount loaned money.
src/ai/api/ai_road.hpp
Show inline comments
 
@@ -317,13 +317,13 @@ public:
 
	 * @return Whether the road depot has been/can be build or not.
 
	 */
 
	static bool BuildRoadDepot(TileIndex tile, TileIndex front);
 

	
 
	/**
 
	 * Builds a road bus or truck station.
 
	 * @param tile Place to build the depot.
 
	 * @param tile Place to build the station.
 
	 * @param front The tile exactly in front of the station.
 
	 *   For drive-through stations either entrance side can be used.
 
	 * @param truck Whether to build a truck (true) or bus (false) station.
 
	 * @param drive_through Whether to make the station drive through or not.
 
	 * @param join_adjacent When building next to an other station, don't create a new station when this flag is true.
 
	 * @pre AIMap::IsValidTile(tile).
0 comments (0 inline, 0 general)