From da2722da363f55a410a906775e254fcfecb49c07 Mon Sep 17 00:00:00 2001 From: alberth Date: Sat, 6 Feb 2010 15:10:12 +0000 Subject: (svn r19043) -Doc: Dcoumenting the GetSmallMapPixels typedef. --- src/smallmap_gui.cpp | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'src/smallmap_gui.cpp') diff --git a/src/smallmap_gui.cpp b/src/smallmap_gui.cpp index 7955dc262..24b72aca6 100644 --- a/src/smallmap_gui.cpp +++ b/src/smallmap_gui.cpp @@ -254,7 +254,12 @@ static const AndOr _smallmap_vehicles_andor[] = { {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[] = { -- cgit v1.2.3-54-g00ecf