# HG changeset patch
# User frosch <frosch@openttd.org>
# Date 2012-06-06 13:13:05
# Node ID f2fbf89f252fd8ba023c8a57bfdca10a33db2393
# Parent  5ca3f7c4fb732c6d891afd86ad4a7ddc687549e3

(svn r24327) -Doc: [Script] Improve documentation of ScriptCompany::GetQuarterlyIncome/Expenses().

diff --git a/src/script/api/script_company.hpp b/src/script/api/script_company.hpp
--- a/src/script/api/script_company.hpp
+++ b/src/script/api/script_company.hpp
@@ -166,6 +166,8 @@ public:
 
 	/**
 	 * Get the income of the company in the given quarter.
+	 * Note that this function only considers recurring income from vehicles;
+	 * it does not include one-time income from selling stuff.
 	 * @param company The company to get the quarterly income of.
 	 * @param quarter The quarter to get the income of.
 	 * @pre ResolveCompanyID(company) != COMPANY_INVALID.
@@ -176,6 +178,9 @@ public:
 
 	/**
 	 * Get the expenses of the company in the given quarter.
+	 * Note that this function only considers recurring expensens from vehicle
+	 * running cost, maintenance and interests; it does not include one-time
+	 * expenses from construction and buying stuff.
 	 * @param company The company to get the quarterly expenses of.
 	 * @param quarter The quarter to get the expenses of.
 	 * @pre ResolveCompanyID(company) != COMPANY_INVALID.