From c36da4841bb79b47626e825efd17f45fe66967e5 Mon Sep 17 00:00:00 2001
From: planetmaker <planetmaker@openttd.org>
Date: Sat, 6 Nov 2010 16:55:15 +0000
Subject: (svn r21101) -Doc: Additions and clarifications of doxygen comments

---
 src/engine.cpp | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

(limited to 'src/engine.cpp')

diff --git a/src/engine.cpp b/src/engine.cpp
index 3c6ae964c..b95c61e27 100644
--- a/src/engine.cpp
+++ b/src/engine.cpp
@@ -285,7 +285,7 @@ Money Engine::GetCost() const
 }
 
 /**
- * Returns max speed for display purposes
+ * Returns max speed of the engine for display purposes
  * @return max speed in km-ish/h
  */
 uint Engine::GetDisplayMaxSpeed() const
@@ -314,6 +314,12 @@ uint Engine::GetDisplayMaxSpeed() const
 	}
 }
 
+/**
+ * Returns the power of the engine for display
+ * and sorting purposes.
+ * Only trains and road vehicles have power
+ * @return power in display units hp
+ */
 uint Engine::GetPower() const
 {
 	/* Only trains and road vehicles have 'power'. */
@@ -328,7 +334,7 @@ uint Engine::GetPower() const
 }
 
 /**
- * Returns the weight for display purposes.
+ * Returns the weight of the engine for display purposes.
  * For dual-headed train-engines this is the weight of both heads
  * @return weight in display units metric tons
  */
@@ -346,7 +352,7 @@ uint Engine::GetDisplayWeight() const
 }
 
 /**
- * Returns the tractive effort for display purposes.
+ * Returns the tractive effort of the engine for display purposes.
  * For dual-headed train-engines this is the tractive effort of both heads
  * @return tractive effort in display units kN
  */
@@ -364,7 +370,7 @@ uint Engine::GetDisplayMaxTractiveEffort() const
 }
 
 /**
- * Returns the vehicle's life length in days.
+ * Returns the vehicle's (not model's!) life length in days.
  * @return the life length
  */
 Date Engine::GetLifeLengthInDays() const
-- 
cgit v1.2.3-54-g00ecf