diff options
| author | planetmaker <planetmaker@openttd.org> | 2010-11-06 16:55:15 +0000 |
|---|---|---|
| committer | planetmaker <planetmaker@openttd.org> | 2010-11-06 16:55:15 +0000 |
| commit | c36da4841bb79b47626e825efd17f45fe66967e5 (patch) | |
| tree | a3f2e54d4e31ff68361dc71459b39a38b8778ec1 | |
| parent | b65df931216207038d3560141166f2547041e18a (diff) | |
| download | openttd-c36da4841bb79b47626e825efd17f45fe66967e5.tar.xz | |
(svn r21101) -Doc: Additions and clarifications of doxygen comments
| -rw-r--r-- | src/engine.cpp | 14 |
1 files changed, 10 insertions, 4 deletions
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 |