(svn r9704) -Documentation: Add comments on industry data macro
authorbelugas
Sat, 21 Apr 2007 02:42:51 +0000
changeset 7014 34b102f35fb9
parent 7013 fb8489ae2770
child 7015 af363e4290ab
(svn r9704) -Documentation: Add comments on industry data macro
src/table/build_industry.h
--- a/src/table/build_industry.h	Fri Apr 20 21:42:06 2007 +0000
+++ b/src/table/build_industry.h	Sat Apr 21 02:42:51 2007 +0000
@@ -5,8 +5,19 @@
 #ifndef BUILD_INDUSTRY_H
 #define BUILD_INDUSTRY_H
 
+/**
+ * Definition of an industry tiles layout.
+ * @param x offset x of this tile
+ * @param y offset y of this tile
+ * @param m index of the tile.
+ * @see _industry_specs
+ * @see IndustryTileTable
+ */
 #define MK(x, y, m) {{x, y}, m}
 
+/**
+ * Terminator of industry tiles layout definition
+ */
 #define MKEND {{-0x80, 0}, 0}
 
 static const IndustryTileTable _tile_table_coal_mine_0[] = {