diff options
author | rubidium <rubidium@openttd.org> | 2009-01-04 11:32:26 +0000 |
---|---|---|
committer | rubidium <rubidium@openttd.org> | 2009-01-04 11:32:26 +0000 |
commit | 702c372744d1fbcd0ef2dbc10c00634c40ababe0 (patch) | |
tree | a15810f96d272ba6dab7e7a438135dea982a6a6e /src/date_type.h | |
parent | 2a47aaf4a8d2dbee8c7c194c33035028583a2c5d (diff) | |
download | openttd-702c372744d1fbcd0ef2dbc10c00634c40ababe0.tar.xz |
(svn r14823) -Document: some variables/structs (Alberth)
Diffstat (limited to 'src/date_type.h')
-rw-r--r-- | src/date_type.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/src/date_type.h b/src/date_type.h index 49b006c60..67122b0b1 100644 --- a/src/date_type.h +++ b/src/date_type.h @@ -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; |