(svn r20269) -Codechange: Use IsLocalCompany() everywhere, document the function and two company globals.

2010-07-31 21:43:07 +00:00
parent 461da5e1d3
commit 603c33efc1
5 changed files with 13 additions and 9 deletions
--- a/src/company_func.h
+++ b/src/company_func.h
@@ -27,6 +27,10 @@ extern CompanyByte _current_company;
 extern Colours _company_colours[MAX_COMPANIES];  ///< NOSAVE: can be determined from company structs
 extern CompanyManagerFace _company_manager_face; ///< for company manager face storage in openttd.cfg

+/**
+ * Is the current company the local company?
+ * @return \c true of the current company is the local company, \c false otherwise.
+ */
 static inline bool IsLocalCompany()
 {
 	return _local_company == _current_company;