(svn r22413) -Document: even more stuff

2011-05-02 20:59:54 +00:00
parent cf30941fab
commit ff143c6708
15 changed files with 78 additions and 6 deletions
--- a/src/economy.cpp
+++ b/src/economy.cpp
@@ -281,7 +281,11 @@ int UpdateCompanyRatingAndValue(Company *c, bool update)
 	return score;
 }

-/*  use INVALID_OWNER as new_owner to delete the company. */
+/**
+ * Change the ownership of all the items of a company.
+ * @param old_owner The company that gets removed.
+ * @param new_owner The company to merge to, or INVALID_OWNER to remove the company.
+ */
 void ChangeOwnershipOfCompanyItems(Owner old_owner, Owner new_owner)
 {
 	/* We need to set _current_company to old_owner before we try to move