changeset 14809:ed24dd38af4d draft

(svn r19399) -Doc: Doxyment enum TownRatingCheckType.
author alberth <alberth@openttd.org>
date Sat, 13 Mar 2010 15:13:19 +0000
parents b1fd146019f7
children 869ae7d2bad4
files src/town.h
diffstat 1 files changed, 6 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/town.h
+++ b/src/town.h
@@ -153,10 +153,13 @@
 void ShowTownViewWindow(TownID town);
 void ExpandTown(Town *t);
 
+/** Action types that a company must ask permission for to a town authority.
+ * @see CheckforTownRating
+ */
 enum TownRatingCheckType {
-	ROAD_REMOVE         = 0,
-	TUNNELBRIDGE_REMOVE = 1,
-	TOWN_RATING_CHECK_TYPE_COUNT,
+	ROAD_REMOVE         = 0,      ///< Removal of a road owned by the town.
+	TUNNELBRIDGE_REMOVE = 1,      ///< Removal of a tunnel or bridge owned by the towb.
+	TOWN_RATING_CHECK_TYPE_COUNT, ///< Number of town checking action types.
 };
 
 /** This is the number of ticks between towns being processed for building new