diff options
author | alberth <alberth@openttd.org> | 2010-03-20 15:23:26 +0000 |
---|---|---|
committer | alberth <alberth@openttd.org> | 2010-03-20 15:23:26 +0000 |
commit | 073f627930ba7816302afe10dcd2b44031c70fb6 (patch) | |
tree | 3b577f5770b3b60696657383df57e75515f050b0 /src/town_cmd.cpp | |
parent | 116a5f56a4c1362446bcf921e4436a19057d105e (diff) | |
download | openttd-073f627930ba7816302afe10dcd2b44031c70fb6.tar.xz |
(svn r19482) -Doc: Doxygen additions/updates.
Diffstat (limited to 'src/town_cmd.cpp')
-rw-r--r-- | src/town_cmd.cpp | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/town_cmd.cpp b/src/town_cmd.cpp index b7e054b71..babc509d4 100644 --- a/src/town_cmd.cpp +++ b/src/town_cmd.cpp @@ -2677,7 +2677,13 @@ CommandCost CheckIfAuthorityAllowsNewStation(TileIndex tile, DoCommandFlag flags return_cmd_error(STR_ERROR_LOCAL_AUTHORITY_REFUSES_TO_ALLOW_THIS); } - +/** Return the town closest to the given tile within \a threshold. + * @param tile Starting point of the search. + * @param threshold Biggest allowed distance to the town. + * @return Closest town to \a tile withinh \a threshold, or \c NULL if there is no such town. + * + * @note This function only uses distance, the #ClosestTownFromTile function also takes town ownership into account. + */ Town *CalcClosestTownFromTile(TileIndex tile, uint threshold) { Town *t; |