(svn r21886) -Codechange: move documentation towards the code to make it more likely to be updated [n].

1 files changed, 6 insertions, 0 deletions

diff --git a/src/newgrf_canal.cpp b/src/newgrf_canal.cpp
index a1753fcd3..12ffc736a 100644
--- a/src/newgrf_canal.cpp
+++ b/src/newgrf_canal.cpp
@@ -97,6 +97,12 @@ static void NewCanalResolver(ResolverObject *res, TileIndex tile, const GRFFile
 }
 
 
+/**
+ * Lookup the base sprite to use for a canal.
+ * @param feature Which canal feature we want.
+ * @param tile Tile index of canal, if appropriate.
+ * @return Base sprite returned by GRF, or 0 if none.
+ */
 SpriteID GetCanalSprite(CanalFeature feature, TileIndex tile)
 {
 	ResolverObject object;