changeset 13992:6edb85a3b23e draft

(svn r18534) -Doc: Add doxy strings to StationCoverageType enum.
author alberth <alberth@openttd.org>
date Sat, 19 Dec 2009 15:04:24 +0000
parents f40051930e5a
children d6215232b503
files src/station_gui.h
diffstat 1 files changed, 4 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/station_gui.h
+++ b/src/station_gui.h
@@ -32,10 +32,11 @@
 	SVW_SHIPS,           ///< List of scheduled ships button
 };
 
+/** Types of cargo to display for station coverage. */
 enum StationCoverageType {
-	SCT_PASSENGERS_ONLY,
-	SCT_NON_PASSENGERS_ONLY,
-	SCT_ALL
+	SCT_PASSENGERS_ONLY,     ///< Draw only passenger class cargos.
+	SCT_NON_PASSENGERS_ONLY, ///< Draw all non-passenger class cargos.
+	SCT_ALL,                 ///< Draw all cargos.
 };
 
 int DrawStationCoverageAreaText(int left, int right, int top, StationCoverageType sct, int rad, bool supplies);