From 57dab45e755a482407bb3cb072165ad29a8f72f2 Mon Sep 17 00:00:00 2001 From: yexo Date: Wed, 1 Apr 2009 08:38:57 +0000 Subject: [PATCH] (svn r15910) -Fix [FS#2777]: Clarify that TILE_INVALID is part of AIMap make doxygen output some documentation for it. --- src/ai/api/ai_company.hpp | 3 ++- src/ai/api/ai_map.hpp | 3 +++ src/ai/api/ai_tunnel.hpp | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/src/ai/api/ai_company.hpp b/src/ai/api/ai_company.hpp index e528a2f954..b75fa5fff1 100644 --- a/src/ai/api/ai_company.hpp +++ b/src/ai/api/ai_company.hpp @@ -153,7 +153,8 @@ public: * 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); diff --git a/src/ai/api/ai_map.hpp b/src/ai/api/ai_map.hpp index bf903a37eb..160da9849a 100644 --- a/src/ai/api/ai_map.hpp +++ b/src/ai/api/ai_map.hpp @@ -17,6 +17,9 @@ public: 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"; } diff --git a/src/ai/api/ai_tunnel.hpp b/src/ai/api/ai_tunnel.hpp index f069c5f491..51d3404298 100644 --- a/src/ai/api/ai_tunnel.hpp +++ b/src/ai/api/ai_tunnel.hpp @@ -50,7 +50,7 @@ public: * @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);