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

(svn r15910) -Fix [FS#2777]: Clarify that TILE_INVALID is part of AIMap make doxygen output some documentation for it.

Browse Source
This commit is contained in:
yexo
2009-04-01 08:38:57 +00:00
parent 8f831ceebc
commit 57dab45e75
3 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
src/ai/api/ai_company.hpp
View File

@@ -153,7 +153,8 @@ public:
* Return the location of a company's HQ. * Return the location of a company's HQ.
* @param company The company the get the HQ of. * @param company The company the get the HQ of.
* @pre ResolveCompanyID(company) != COMPANY_INVALID. * @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); static TileIndex GetCompanyHQ(CompanyID company);

3
src/ai/api/ai_map.hpp
View File

@@ -17,6 +17,9 @@ public:
TILE_INVALID = INVALID_TILE, //!< Invalid TileIndex. TILE_INVALID = INVALID_TILE, //!< Invalid TileIndex.
}; };
#endif /* DEFINE_SCRIPT_FILES */ #endif /* DEFINE_SCRIPT_FILES */
#ifdef DOXYGEN_SKIP
const static TileIndex TILE_INVALID; //!< Invalid TileIndex.
#endif
static const char *GetClassName() { return "AIMap"; } static const char *GetClassName() { return "AIMap"; }

2
src/ai/api/ai_tunnel.hpp
View File

@@ -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. * @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). * @pre AIMap::IsValidTile(tile).
* @return The TileIndex that is the other end of the (would be) tunnel, or * @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); static TileIndex GetOtherTunnelEnd(TileIndex tile);