summaryrefslogtreecommitdiff
path: root/src/newgrf_canal.cpp
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2012-11-10 20:46:39 +0000
committeralberth <alberth@openttd.org>2012-11-10 20:46:39 +0000
commit33ff55a8f1287643986621e7130e8acddf42b221 (patch)
tree04af02a5ad82e979ec200570b38628dccc860cdf /src/newgrf_canal.cpp
parent4c9bea2a714da675217522c39113ba2c2c5bbee4 (diff)
downloadopenttd-33ff55a8f1287643986621e7130e8acddf42b221.tar.xz
(svn r24693) -Doc: Add some doxymentation into the newgrf code.
Diffstat (limited to 'src/newgrf_canal.cpp')
-rw-r--r--src/newgrf_canal.cpp9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/newgrf_canal.cpp b/src/newgrf_canal.cpp
index 48c1490e6..13b7e15d6 100644
--- a/src/newgrf_canal.cpp
+++ b/src/newgrf_canal.cpp
@@ -18,8 +18,9 @@
/** Table of canal 'feature' sprite groups */
WaterFeature _water_feature[CF_END];
+/** Scope resolver of a canal tile. */
struct CanalScopeResolver : public ScopeResolver {
- TileIndex tile;
+ TileIndex tile; ///< Tile containing the canal.
CanalScopeResolver(ResolverObject *ro, TileIndex tile);
@@ -89,8 +90,12 @@ CanalScopeResolver::CanalScopeResolver(ResolverObject *ro, TileIndex tile) : Sco
}
/**
- * @param tile Tile index of canal.
+ * Canal resolver constructor.
* @param grffile Grf file.
+ * @param tile Tile index of canal.
+ * @param callback Callback ID.
+ * @param callback_param1 First parameter (var 10) of the callback.
+ * @param callback_param2 Second parameter (var 18) of the callback.
*/
CanalResolverObject::CanalResolverObject(const GRFFile *grffile, TileIndex tile,
CallbackID callback, uint32 callback_param1, uint32 callback_param2)