Improve documentation

This commit is contained in:
Martchus 2017-11-29 19:11:01 +01:00
parent 1ab9349eaa
commit d7185fc1bc
2 changed files with 3 additions and 2 deletions

View File

@ -292,7 +292,7 @@ const char *DateTime::printDayOfWeek(DayOfWeek dayOfWeek, bool abbreviation)
#if defined(PLATFORM_UNIX) && !defined(PLATFORM_MAC) #if defined(PLATFORM_UNIX) && !defined(PLATFORM_MAC)
/*! /*!
* \brief Returns a DateTime object that is set to the current date and time on this computer, expressed as the GMT time. * \brief Returns a DateTime object that is set to the current date and time on this computer, expressed as the GMT time.
* \remarks * \remarks Only available under UNIX-like systems supporting clock_gettime().
*/ */
DateTime DateTime::exactGmtNow() DateTime DateTime::exactGmtNow()
{ {

View File

@ -39,6 +39,7 @@ enum class DayOfWeek {
/*! /*!
* \brief Specifies the date part. * \brief Specifies the date part.
* \remarks Intended for internal use only.
* \sa DateTime::getDatePart() * \sa DateTime::getDatePart()
*/ */
enum class DatePart { enum class DatePart {
@ -316,7 +317,7 @@ constexpr inline TimeSpan DateTime::timeOfDay() const
} }
/*! /*!
* \brief Returns an indication whether the year of the dae represented by this instance is a leap year. * \brief Returns an indication whether the year represented by this instance is a leap year.
*/ */
inline bool DateTime::isLeapYear() const inline bool DateTime::isLeapYear() const
{ {