dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r22239) -Doc: Further engine doxyment additions.

Browse Source
This commit is contained in:
alberth
2011-03-13 16:43:00 +00:00
parent 911dfa52bb
commit bb4d832146
3 changed files with 36 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/engine.cpp
View File

@@ -542,13 +542,21 @@ static void CheckRailIntroduction()
void ShowEnginePreviewWindow(EngineID engine);
/* Determine if an engine type is a wagon (and not a loco) */
/**
* Determine whether an engine type is a wagon (and not a loco).
* @param index %Engine getting queried.
* @return Whether the queried engine is a wagon.
*/
static bool IsWagon(EngineID index)
{
const Engine *e = Engine::Get(index);
return e->type == VEH_TRAIN && e->u.rail.railveh_type == RAILVEH_WAGON;
}
/**
* Update #reliability of engine \a e, (if needed) update the engine GUIs.
* @param e %Engine to update.
*/
static void CalcEngineReliability(Engine *e)
{
uint age = e->age;
@@ -682,6 +690,11 @@ void StartupEngines()
InvalidateWindowClassesData(WC_BUILD_VEHICLE);
}
/**
* Company \a company accepts engine \a eid for preview.
* @param eid Engine being accepted (is under preview).
* @param company Current company previewing the engine.
*/
static void AcceptEnginePreview(EngineID eid, CompanyID company)
{
Engine *e = Engine::Get(eid);