Mercurial > hg > openttd
changeset 14474:d98b126c40e0 draft
(svn r19043) -Doc: Dcoumenting the GetSmallMapPixels typedef.
author | alberth <alberth@openttd.org> |
---|---|
date | Sat, 06 Feb 2010 15:10:12 +0000 |
parents | 4387f17e9ff1 |
children | 213986bc2e7a |
files | src/smallmap_gui.cpp |
diffstat | 1 files changed, 6 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/smallmap_gui.cpp +++ b/src/smallmap_gui.cpp @@ -254,7 +254,12 @@ {MKCOLOUR(0x00D7D700), MKCOLOUR(0xFF0000FF)}, }; -typedef uint32 GetSmallMapPixels(TileIndex tile); ///< Typedef callthrough function +/** + * Function signature of the function to retrieve the colour data of a tile for display at the smallmap. + * @param tile Tile that gets displayed. + * @return Colour data to display. + */ +typedef uint32 GetSmallMapPixels(TileIndex tile); /** Mapping of tile type to importance of the tile (higher number means more interesting to show). */ static const byte _tiletype_importance[] = {