(svn r14823) -Document: some variables/structs (Alberth)

This commit is contained in:
rubidium 2009-01-04 11:32:26 +00:00
parent 2a47aaf4a8
commit 702c372744
3 changed files with 12 additions and 8 deletions

View File

@ -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;

View File

@ -46,10 +46,14 @@ typedef int32 Year;
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;

View File

@ -52,8 +52,8 @@ void BuildOilRig(TileIndex tile);
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];