mirrors
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

(svn r21101) -Doc: Additions and clarifications of doxygen comments

This commit is contained in:
planetmaker 2010-11-06 16:55:15 +00:00
parent b65df93121
commit c36da4841b
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/engine.cpp
View File

@ -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