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

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

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;