summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2010-02-06 15:10:12 +0000
committeralberth <alberth@openttd.org>2010-02-06 15:10:12 +0000
commitda2722da363f55a410a906775e254fcfecb49c07 (patch)
tree6cf58e6e7e1d56df7ff94c222053c8105c753343
parent4cf65e6e81796a3c21d7186fe3fdcff89939426f (diff)
downloadopenttd-da2722da363f55a410a906775e254fcfecb49c07.tar.xz
(svn r19043) -Doc: Dcoumenting the GetSmallMapPixels typedef.
-rw-r--r--src/smallmap_gui.cpp7
1 files changed, 6 insertions, 1 deletions
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[] = {