(svn r19414) -Doc: Several doxygen additions and corrections.

This commit is contained in:
alberth
2010-03-14 12:39:24 +00:00
parent 130f9f96b3
commit 19dff3a6b2
6 changed files with 16 additions and 9 deletions

View File

@@ -159,6 +159,11 @@ void InvalidateCompanyWindows(const Company *company)
SetWindowDirty(WC_FINANCES, cid);
}
/**
* Verify whether the company can pay the bill.
* @param cost [inout] Money to pay, is changed to an error if the company does not have enough money.
* @return Function returns \c true if the company has enough money, else it returns \c false.
*/
bool CheckCompanyHasMoney(CommandCost &cost)
{
if (cost.GetCost() > 0) {