From aaeb53066dff98cac2d66d1f02f545d14c9f650c Mon Sep 17 00:00:00 2001 From: smatz Date: Wed, 1 Jul 2009 18:18:12 +0000 Subject: [PATCH] (svn r16713) -Doc: document the Subsidy struct --- src/subsidy_type.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/subsidy_type.h b/src/subsidy_type.h index 8aa6738a42..734a9c87c4 100644 --- a/src/subsidy_type.h +++ b/src/subsidy_type.h @@ -8,12 +8,12 @@ #include "cargo_type.h" #include "company_type.h" +/** Struct about subsidies, both offered and awarded */ struct Subsidy { - CargoID cargo_type; - byte age; - /* from and to can either be TownID, StationID or IndustryID */ - uint16 from; - uint16 to; + CargoID cargo_type; ///< Cargo type involved in this subsidy, CT_INVALID for invalid subsidy + byte age; ///< Subsidy age; < 12 is unawarded, >= 12 is awarded + uint16 from; ///< Index of source. Either TownID, IndustryID or StationID, when awarded. + uint16 to; ///< Index of destination. Either TownID, IndustryID or StationID, when awarded. }; extern Subsidy _subsidies[MAX_COMPANIES];