Mercurial > hg > openttd
changeset 10566:188a425d5d00 draft
(svn r14823) -Document: some variables/structs (Alberth)
| author | rubidium <rubidium@openttd.org> |
|---|---|
| date | Sun, 04 Jan 2009 11:32:26 +0000 |
| parents | fc05c0f28834 |
| children | 655a9991ad4a |
| files | src/date.cpp src/date_type.h src/industry_cmd.cpp |
| diffstat | 3 files changed, 12 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/src/date.cpp +++ b/src/date.cpp @@ -17,9 +17,9 @@ #include "rail_gui.h" #include "saveload.h" -Year _cur_year; -Month _cur_month; -Date _date; +Year _cur_year; ///< Current year, starting at 0 +Month _cur_month; ///< Current month (0..11) +Date _date; ///< Current date in days (day counter) DateFract _date_fract;
--- a/src/date_type.h +++ b/src/date_type.h @@ -46,10 +46,14 @@ typedef uint8 Month; typedef uint8 Day; +/** + * Data structure to convert between Date and triplet (year, month, and day). + * @see ConvertDateToYMD(), ConvertYMDToDate() + */ struct YearMonthDay { - Year year; - Month month; ///< 0 - 11 - Day day; ///< 1 - 31 + Year year; ///< Year (0...) + Month month; ///< Month (0..11) + Day day; ///< Day (1..31) }; static const Year INVALID_YEAR = -1;
--- a/src/industry_cmd.cpp +++ b/src/industry_cmd.cpp @@ -52,8 +52,8 @@ static byte _industry_sound_ctr; static TileIndex _industry_sound_tile; -int _total_industries; //general counter -uint16 _industry_counts[NUM_INDUSTRYTYPES]; // Number of industries per type ingame +int _total_industries; ///< General counter +uint16 _industry_counts[NUM_INDUSTRYTYPES]; ///< Number of industries per type ingame IndustrySpec _industry_specs[NUM_INDUSTRYTYPES]; IndustryTileSpec _industry_tile_specs[NUM_INDUSTRYTILES];