From a69e274c7083628e2e9928a3e1b7ac62d698a0c1 Mon Sep 17 00:00:00 2001
From: alberth <alberth@openttd.org>
Date: Sat, 6 Feb 2010 15:10:12 +0000
Subject: [PATCH] (svn r19043) -Doc: Dcoumenting the GetSmallMapPixels typedef.

---
 src/smallmap_gui.cpp | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/src/smallmap_gui.cpp b/src/smallmap_gui.cpp
index 7955dc2628..24b72aca6e 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[] = {