Mercurial > hg > openttd
changeset 11547:ac73bd5420ca draft
(svn r15910) -Fix [FS#2777]: Clarify that TILE_INVALID is part of AIMap make doxygen output some documentation for it.
| author | yexo <yexo@openttd.org> |
|---|---|
| date | Wed, 01 Apr 2009 08:38:57 +0000 |
| parents | 17c669ba1319 |
| children | 9c985010bebe |
| files | src/ai/api/ai_company.hpp src/ai/api/ai_map.hpp src/ai/api/ai_tunnel.hpp |
| diffstat | 3 files changed, 6 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/src/ai/api/ai_company.hpp +++ b/src/ai/api/ai_company.hpp @@ -153,7 +153,8 @@ * Return the location of a company's HQ. * @param company The company the get the HQ of. * @pre ResolveCompanyID(company) != COMPANY_INVALID. - * @return The tile of the company's HQ, this tile is the most nothern tile of that HQ, or TILE_INVALID if there is no HQ yet. + * @return The tile of the company's HQ, this tile is the most nothern tile + * of that HQ, or AIMap::TILE_INVALID if there is no HQ yet. */ static TileIndex GetCompanyHQ(CompanyID company);
--- a/src/ai/api/ai_map.hpp +++ b/src/ai/api/ai_map.hpp @@ -17,6 +17,9 @@ TILE_INVALID = INVALID_TILE, //!< Invalid TileIndex. }; #endif /* DEFINE_SCRIPT_FILES */ +#ifdef DOXYGEN_SKIP + const static TileIndex TILE_INVALID; //!< Invalid TileIndex. +#endif static const char *GetClassName() { return "AIMap"; }
--- a/src/ai/api/ai_tunnel.hpp +++ b/src/ai/api/ai_tunnel.hpp @@ -50,7 +50,7 @@ * @param tile The tile that is an entrance to a tunnel or the tile where you may want to build a tunnel. * @pre AIMap::IsValidTile(tile). * @return The TileIndex that is the other end of the (would be) tunnel, or - * TILE_INVALID if no other end was found (can't build tunnel). + * AIMap::TILE_INVALID if no other end was found (can't build tunnel). */ static TileIndex GetOtherTunnelEnd(TileIndex tile);