(svn r19043) -Doc: Dcoumenting the GetSmallMapPixels typedef.

This commit is contained in:
alberth 2010-02-06 15:10:12 +00:00
parent 4cf65e6e81
commit da2722da36

View File

@ -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[] = {