From e8ddf001c87790cde6e03e9ca47714b6fc30266c Mon Sep 17 00:00:00 2001
From: rubidium <rubidium@openttd.org>
Date: Sat, 19 Sep 2009 09:51:14 +0000
Subject: (svn r17570) -Fix: a number of Doxygen warnings about missing
 parameters, which were sometimes missing and sometimes just typos

---
 src/autoreplace_func.h | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

(limited to 'src/autoreplace_func.h')

diff --git a/src/autoreplace_func.h b/src/autoreplace_func.h
index 5a3eee934..8f0bf2c56 100644
--- a/src/autoreplace_func.h
+++ b/src/autoreplace_func.h
@@ -24,8 +24,9 @@ void RemoveAllEngineReplacement(EngineRenewList *erl);
 
 /**
  * Retrieve the engine replacement in a given renewlist for an original engine type.
- * @param  erl The renewlist to search in.
- * @param  engine Engine type to be replaced.
+ * @param erl The renewlist to search in.
+ * @param engine Engine type to be replaced.
+ * @param group The group related to this replacement.
  * @return The engine type to replace with, or INVALID_ENGINE if no
  * replacement is in the list.
  */
@@ -36,6 +37,7 @@ EngineID EngineReplacement(EngineRenewList erl, EngineID engine, GroupID group);
  * @param erl The renewlist to add to.
  * @param old_engine The original engine type.
  * @param new_engine The replacement engine type.
+ * @param group The group related to this replacement.
  * @param flags The calling command flags.
  * @return 0 on success, CMD_ERROR on failure.
  */
@@ -45,6 +47,7 @@ CommandCost AddEngineReplacement(EngineRenewList *erl, EngineID old_engine, Engi
  * Remove an engine replacement from a given renewlist.
  * @param erl The renewlist from which to remove the replacement
  * @param engine The original engine type.
+ * @param group The group related to this replacement.
  * @param flags The calling command flags.
  * @return 0 on success, CMD_ERROR on failure.
  */
@@ -63,6 +66,7 @@ static inline void RemoveAllEngineReplacementForCompany(Company *c)
  * Retrieve the engine replacement for the given company and original engine type.
  * @param c company.
  * @param engine Engine type.
+ * @param group The group related to this replacement.
  * @return The engine type to replace with, or INVALID_ENGINE if no
  * replacement is in the list.
  */
@@ -74,7 +78,8 @@ static inline EngineID EngineReplacementForCompany(const Company *c, EngineID en
 /**
  * Check if a company has a replacement set up for the given engine.
  * @param c Company.
- * @param  engine Engine type to be replaced.
+ * @param engine Engine type to be replaced.
+ * @param group The group related to this replacement.
  * @return true if a replacement was set up, false otherwise.
  */
 static inline bool EngineHasReplacementForCompany(const Company *c, EngineID engine, GroupID group)
@@ -87,6 +92,7 @@ static inline bool EngineHasReplacementForCompany(const Company *c, EngineID eng
  * @param c Company.
  * @param old_engine The original engine type.
  * @param new_engine The replacement engine type.
+ * @param group The group related to this replacement.
  * @param flags The calling command flags.
  * @return 0 on success, CMD_ERROR on failure.
  */
@@ -99,6 +105,7 @@ static inline CommandCost AddEngineReplacementForCompany(Company *c, EngineID ol
  * Remove an engine replacement for the company.
  * @param c Company.
  * @param engine The original engine type.
+ * @param group The group related to this replacement.
  * @param flags The calling command flags.
  * @return 0 on success, CMD_ERROR on failure.
  */
-- 
cgit v1.2.3-54-g00ecf