From 0ca9fd7dc2ff8077c188e000b7569e3ff1072301 Mon Sep 17 00:00:00 2001 From: rubidium Date: Sun, 9 Sep 2007 10:13:17 +0000 Subject: (svn r11065) -Documentation [FS#1186]: of the dirty marking/repainting subsystem. Patch by Progman. --- src/clear_cmd.cpp | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) (limited to 'src/clear_cmd.cpp') diff --git a/src/clear_cmd.cpp b/src/clear_cmd.cpp index 1fd1ba304..047f003c3 100644 --- a/src/clear_cmd.cpp +++ b/src/clear_cmd.cpp @@ -47,7 +47,14 @@ struct TerraformerState { int modheight_count; ///< amount of entries in "modheight". int tile_table_count; ///< amount of entries in "tile_table". - TileIndex tile_table[TERRAFORMER_TILE_TABLE_SIZE]; ///< Dirty tiles, i.e. at least one corner changed. + /** + * Dirty tiles, i.e.\ at least one corner changed. + * + * This array contains the tiles which are or will be marked as dirty. + * + * @ingroup dirty + */ + TileIndex tile_table[TERRAFORMER_TILE_TABLE_SIZE]; TerraformerHeightMod modheight[TERRAFORMER_MODHEIGHT_SIZE]; ///< Height modifications. }; @@ -106,6 +113,7 @@ static void TerraformSetHeightOfTile(TerraformerState *ts, TileIndex tile, int h * * @param ts TerraformerState. * @param tile Tile. + * @ingroup dirty */ static void TerraformAddDirtyTile(TerraformerState *ts, TileIndex tile) { @@ -128,6 +136,7 @@ static void TerraformAddDirtyTile(TerraformerState *ts, TileIndex tile) * * @param ts TerraformerState. * @param tile Tile. + * @ingroup dirty */ static void TerraformAddDirtyTileAround(TerraformerState *ts, TileIndex tile) { -- cgit v1.2.3-54-g00ecf