summaryrefslogtreecommitdiff
path: root/src/water_map.h
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-05-01 19:14:12 +0000
committerrubidium <rubidium@openttd.org>2011-05-01 19:14:12 +0000
commit1a515e6344028854c855671c19f49d8f869eb18f (patch)
treee1bba97c1a8fd80f564729cc2d5fc2049110cb2a /src/water_map.h
parentb27dd1dcd7375dae63724879eb0f56dd703e5312 (diff)
downloadopenttd-1a515e6344028854c855671c19f49d8f869eb18f.tar.xz
(svn r22405) -Document: some more "random-ish" tidbits
Diffstat (limited to 'src/water_map.h')
-rw-r--r--src/water_map.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/src/water_map.h b/src/water_map.h
index f768a7d78..d26b93210 100644
--- a/src/water_map.h
+++ b/src/water_map.h
@@ -17,10 +17,10 @@
/** Available water tile types. */
enum WaterTileType {
- WATER_TILE_CLEAR, // Plain water.
- WATER_TILE_COAST, // Coast.
- WATER_TILE_LOCK, // Water lock.
- WATER_TILE_DEPOT, // Water Depot.
+ WATER_TILE_CLEAR, ///< Plain water.
+ WATER_TILE_COAST, ///< Coast.
+ WATER_TILE_LOCK, ///< Water lock.
+ WATER_TILE_DEPOT, ///< Water Depot.
};
/** classes of water (for #WATER_TILE_CLEAR water tile type). */
@@ -30,6 +30,7 @@ enum WaterClass {
WATER_CLASS_RIVER, ///< River.
WATER_CLASS_INVALID, ///< Used for industry tiles on land (also for oilrig if newgrf says so).
};
+/** Helper information for extract tool. */
template <> struct EnumPropsT<WaterClass> : MakeEnumPropsT<WaterClass, byte, WATER_CLASS_SEA, WATER_CLASS_INVALID, WATER_CLASS_INVALID, 2> {};
/** Sections of the water depot. */
@@ -232,7 +233,7 @@ static inline DiagDirection GetShipDepotDirection(TileIndex t)
/**
* Get the most northern tile of a ship depot.
- * @param tile One of the tiles of the ship depot.
+ * @param t One of the tiles of the ship depot.
* @return The northern tile of the depot.
*/
static inline TileIndex GetShipDepotNorthTile(TileIndex t)