(svn r9619) -Documentation: Comments on drawing arrays of houses and industries

1 files changed, 15 insertions, 0 deletions

diff --git a/src/table/industry_land.h b/src/table/industry_land.h
index 9ef40c2e4..91d2e02cf 100644
--- a/src/table/industry_land.h
+++ b/src/table/industry_land.h
@@ -15,8 +15,23 @@ struct DrawIndustrySpec4Struct {
 	byte image_3;
 };
 
+
+/**
+ * Macro to ease the declaration of the array
+ * @param s1 sprite ID of ground sprite
+ * @param p1 palette ID of ground sprite
+ * @param s2 sprite ID of building sprite
+ * @param p2 palette ID of building sprite
+ * @param sx coordinate x of the sprite
+ * @param sy coordinate y of the sprite
+ * @param w width of the sprite
+ * @param h height of the sprite
+ * @param dz virtual height of the sprite
+ * @param p this allows to specify a special drawing procedure.
+ * @see DrawBuildingsTileStruct */
 #define M(s1, p1, s2, p2, sx, sy, w, h, dz, p) { { s1, p1 }, { s2, p2 }, sx, sy, w - 1, h - 1, dz, p }
 
+/** Structure for industry tiles drawing */
 static const DrawBuildingsTileStruct _industry_draw_tile_data[NUM_INDUSTRY_GFXES * 4] = {
 	M(     0xf54, PAL_NONE,      0x7db, PAL_NONE,  7,  0,  9,  9,  10, 0),
 	M(     0xf54, PAL_NONE,      0x7dc, PAL_NONE,  7,  0,  9,  9,  30, 0),