@@ -26,227 +26,289 @@ int64_t seconds; uint32_t microseconds; } /** + * \brief Creates a new OFDate with the current date and time. + * * \return A new, autoreleased OFDate with the current date and time */ + date; /** + * \brief Creates a new OFDate with the specified date and time since + * 1970-01-01T00:00:00Z. + * * \param seconds The seconds since 1970-01-01T00:00:00Z * \return A new, autoreleased OFDate with the specified date and time */ + dateWithTimeIntervalSince1970: (int64_t)seconds; /** + * \brief Creates a new OFDate with the specified date and time since + * 1970-01-01T00:00:00Z. + * * \param seconds The seconds since 1970-01-01T00:00:00Z * \param microseconds The microsecond part of the time * \return A new, autoreleased OFDate with the specified date and time */ + dateWithTimeIntervalSince1970: (int64_t)seconds microseconds: (uint32_t)microseconds; /** + * \brief Creates a new OFDate with the specified date and time since now. + * * \param seconds The seconds since now * \return A new, autoreleased OFDate with the specified date and time */ + dateWithTimeIntervalSinceNow: (int64_t)seconds; /** + * \brief Creates a new OFDate with the specified date and time since now. + * * \param seconds The seconds since now * \param microseconds The microsecond part of the time * \return A new, autoreleased OFDate with the specified date and time */ + dateWithTimeIntervalSinceNow: (int64_t)seconds microseconds: (uint32_t)microseconds; /** - * Returns a date in the distant future. The date is system-dependant. + * \brief Returns a date in the distant future. + * + * The date is system-dependant. * * \return A date in the distant future */ + distantFuture; /** - * Returns a date in the distant past. The date is system-dependant. + * \brief Returns a date in the distant past. + * + * The date is system-dependant. * * \return A date in the distant past */ + distantPast; /** - * Initializes an already allocated OFDate with the specified date and time. + * \brief Initializes an already allocated OFDate with the specified date and + * time since 1970-01-01T00:00:00Z. * * \param seconds The seconds since 1970-01-01T00:00:00Z * \return An initialized OFDate with the specified date and time */ - initWithTimeIntervalSince1970: (int64_t)seconds; /** - * Initializes an already allocated OFDate with the specified date and time. + * \brief Initializes an already allocated OFDate with the specified date and + * time since 1970-01-01T00:00:00Z. * * \param seconds The seconds since 1970-01-01T00:00:00Z * \param microseconds The microsecond part of the time * \return An initialized OFDate with the specified date and time */ - initWithTimeIntervalSince1970: (int64_t)seconds microseconds: (uint32_t)microseconds; /** - * Initializes an already allocated OFDate with the specified date and time. + * \brief Initializes an already allocated OFDate with the specified date and + * time since now. * * \param seconds The seconds since now * \return A new, autoreleased OFDate with the specified date and time */ - initWithTimeIntervalSinceNow: (int64_t)seconds; /** - * Initializes an already allocated OFDate with the specified date and time. + * \brief Initializes an already allocated OFDate with the specified date and + * time since now. * * \param seconds The seconds since now * \param microseconds The microsecond part of the time * \return A new, autoreleased OFDate with the specified date and time */ - initWithTimeIntervalSinceNow: (int64_t)seconds microseconds: (uint32_t)microseconds; /** + * \brief Returns the microsecond of the date. + * * \return The microsecond of the date */ - (uint32_t)microsecond; /** + * \brief Returns the second of the date. + * * \return The second of the date */ - (uint8_t)second; /** + * \brief Returns the minute of the date. + * * \return The minute of the date */ - (uint8_t)minute; /** + * \brief Returns the hour of the date. + * * \return The hour of the date */ - (uint8_t)hour; /** + * \brief Returns the hour of the date in local time. + * * \return The hour of the date in local time */ - (uint8_t)localHour; /** + * \brief Returns the day of the month. + * * \return The day of the month of the date */ - (uint8_t)dayOfMonth; /** + * \brief Returns the day of the month of the date in local time. + * * \return The day of the month of the date in local time */ - (uint8_t)localDayOfMonth; /** + * \brief Returns the month of the year of the date. + * * \return The month of the year of the date */ - (uint8_t)monthOfYear; /** + * \brief Returns the month of the year of the date in local time. + * * \return The month of the year of the date in local time */ - (uint8_t)localMonthOfYear; /** + * \brief Returns the year of the date. + * * \return The year of the date */ - (uint16_t)year; /** + * \brief Returns the day of the week of the date. + * * \return The day of the week of the date */ - (uint8_t)dayOfWeek; /** + * \brief Returns the day of the week of the date in local time. + * * \return The day of the week of the date in local time */ - (uint8_t)localDayOfWeek; /** + * \brief Returns the day of the year of the date. + * * \return The day of the year of the date */ - (uint16_t)dayOfYear; /** + * \brief Returns the day of the year of the date in local time. + * * \return The day of the year of the date in local time */ - (uint16_t)localDayOfYear; /** - * Creates a string of the date with the specified format. + * \brief Creates a string of the date with the specified format. * * See the manpage for strftime for information on the format. * * \param fmt The format for the date string * \return A new, autoreleased OFString */ - (OFString*)dateStringWithFormat: (OFString*)fmt; /** - * Creates a string of the local date with the specified format. + * \brief Creates a string of the local date with the specified format. * * See the manpage for strftime for information on the format. * * \param fmt The format for the date string * \return A new, autoreleased OFString */ - (OFString*)localDateStringWithFormat: (OFString*)fmt; /** + * \brief Returns the earlier of the two dates. + * * \param date Another date * \return The earlier date of the two dates */ - (OFDate*)earlierDate: (OFDate*)otherDate; /** + * \brief Returns the later of the two dates. + * * \param date Another date * \return The later date of the two dates */ - (OFDate*)laterDate: (OFDate*)otherDate; /** + * \brief Returns the seconds since 1970-01-01T00:00:00Z. + * * \return The seconds since 1970-01-01T00:00:00Z */ - (int64_t)timeIntervalSince1970; /** + * \brief Returns the microseconds part of the seconds since + * 1970-01-01T00:00:00Z. + * * \return The microseconds part of the seconds since 1970-01-01T00:00:00Z */ - (uint32_t)microsecondsOfTimeIntervalSince1970; /** + * \brief Returns the seconds the receiver is after the date. + * * \return The seconds the receiver is after the date. */ - (int64_t)timeIntervalSinceDate: (OFDate*)otherDate; /** + * \brief Returns the microseconds part of the seconds the receiver is after the + * date. + * * \return The microseconds part of the seconds the receiver is after the date */ - (uint32_t)microsecondsOfTimeIntervalSinceDate: (OFDate*)otherDate; /** - * Returns a new date with the specified time interval added. + * \brief Returns a new date with the specified time interval added. * * \param seconds The seconds after the date * \return A new, autoreleased OFDate */ - (OFDate*)dateByAddingTimeInterval: (int64_t)seconds; /** - * Returns a new date with the specified time interval added. + * \brief Returns a new date with the specified time interval added. * * \param seconds The seconds after the date * \param microseconds The microseconds after the date * \return A new, autoreleased OFDate */ - (OFDate*)dateByAddingTimeInterval: (int64_t)seconds withMicroseconds: (uint32_t)microseconds; @end