diff --git a/inc/Helpers/TimeAndDate.hpp b/inc/Helpers/TimeAndDate.hpp index 39281373bc1fa678be4acd8c081194cfb8332f73..8ddc566973bddfbf78c6fa695d141935d12c06d7 100644 --- a/inc/Helpers/TimeAndDate.hpp +++ b/inc/Helpers/TimeAndDate.hpp @@ -8,7 +8,7 @@ * A class that represents the time and date. * * @note - * This class represents UTC date + * This class represents UTC (Coordinated Universal Time) date */ class TimeAndDate { public: @@ -22,16 +22,13 @@ public: /** * Assign the instances with the Unix epoch 1/1/1970 00:00:00 */ - TimeAndDate(); // + TimeAndDate(); /** - * @param year the year as it used in Gregorian calendar (the well known civil calendar). For - * example 2019 - * @param month the month as it used in Gregorian calendar. There isn't 0 month so we are - * start counting from 1! - * @param day the day as it used in Gregorian calendar. There isn't 0 day so we are start - * counting from 1! - * @param hour UTC (Coordinated Universal Time) hour in 24 format + * @param year the year as it used in Gregorian calendar + * @param month the month as it used in Gregorian calendar + * @param day the day as it used in Gregorian calendar + * @param hour UTC hour in 24 format * @param minute UTC minutes * @param second UTC seconds */ diff --git a/src/Helpers/TimeAndDate.cpp b/src/Helpers/TimeAndDate.cpp index a0a02c685b416e3648ea1228ec48e0005cd9d718..d0a5fc7d937744663c501f3c54b7329cbe1ffa29 100644 --- a/src/Helpers/TimeAndDate.cpp +++ b/src/Helpers/TimeAndDate.cpp @@ -13,7 +13,7 @@ TimeAndDate::TimeAndDate() { TimeAndDate::TimeAndDate(uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, uint8_t second) { - // check if the parameters makes sense + // check if the parameters make sense assertI(2019 <= year, ErrorHandler::InternalErrorType::InvalidDate); assertI(1 <= month && month <= 12, ErrorHandler::InternalErrorType::InvalidDate); assertI(1 <= day && day <= 31, ErrorHandler::InternalErrorType::InvalidDate);