From b0537d271f364486246bdab3be8a2bd44d43022f Mon Sep 17 00:00:00 2001 From: rubidium Date: Sun, 19 Oct 2008 15:39:12 +0000 Subject: (svn r14491) -Documentation: updates/additions of doxygen docs (Alberth) --- src/tile_map.cpp | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'src/tile_map.cpp') diff --git a/src/tile_map.cpp b/src/tile_map.cpp index f6cb0adef..27b0a08a1 100644 --- a/src/tile_map.cpp +++ b/src/tile_map.cpp @@ -7,6 +7,11 @@ #include "tile_map.h" #include "core/math_func.hpp" +/** + * Return the slope of a given tile + * @param tile Tile to compute slope of + * @param h If not \c NULL, pointer to storage of z height + * @return Slope of the tile, except for the HALFTILE part */ Slope GetTileSlope(TileIndex tile, uint *h) { uint a; @@ -42,6 +47,10 @@ Slope GetTileSlope(TileIndex tile, uint *h) return (Slope)r; } +/** + * Get bottom height of the tile + * @param tile Tile to compute height of + * @return Minimum height of the tile */ uint GetTileZ(TileIndex tile) { if (TileX(tile) == MapMaxX() || TileY(tile) == MapMaxY()) return 0; @@ -54,7 +63,10 @@ uint GetTileZ(TileIndex tile) return h * TILE_HEIGHT; } - +/** + * Get top height of the tile + * @param tile Tile to compute height of + * @return Maximum height of the tile */ uint GetTileMaxZ(TileIndex t) { if (TileX(t) == MapMaxX() || TileY(t) == MapMaxY()) return 0; -- cgit v1.2.3-54-g00ecf