cpp/openttd-patchpack/source Changeset - r11542:6c14b3991cde

Changeset - r11542:6c14b3991cde

Parent rev.

Child rev.

[Not reviewed]

master

0 3 0

yexo - 15 years ago 2009-04-01 08:38:57
yexo@openttd.org

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

3 files changed with 6 insertions and 2 deletions:

src/ai/api/ai_company.hpp

src/ai/api/ai_map.hpp

src/ai/api/ai_tunnel.hpp

0 comments (0 inline, 0 general)

src/ai/api/ai_company.hpp

➞

Show inline comments

@@ @@ -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);

src/ai/api/ai_map.hpp

➞

Show inline comments

@@ @@ -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"; }

src/ai/api/ai_tunnel.hpp

➞

Show inline comments

@@ @@ -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);

0 comments (0 inline, 0 general)