Skip to content
Snippets Groups Projects
Commit be529bf5 authored by Theodoros Katzalis's avatar Theodoros Katzalis
Browse files

Minor changes in the documentation

parent fdffcc1d
No related branches found
No related tags found
No related merge requests found
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
* A class that represents the time and date. * A class that represents the time and date.
* *
* @note * @note
* This class represents UTC date * This class represents UTC (Coordinated Universal Time) date
*/ */
class TimeAndDate { class TimeAndDate {
public: public:
...@@ -22,16 +22,13 @@ public: ...@@ -22,16 +22,13 @@ public:
/** /**
* Assign the instances with the Unix epoch 1/1/1970 00:00:00 * 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 * @param year the year as it used in Gregorian calendar
* example 2019 * @param month the month as it used in Gregorian calendar
* @param month the month as it used in Gregorian calendar. There isn't 0 month so we are * @param day the day as it used in Gregorian calendar
* start counting from 1! * @param hour UTC hour in 24 format
* @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 minute UTC minutes * @param minute UTC minutes
* @param second UTC seconds * @param second UTC seconds
*/ */
......
...@@ -13,7 +13,7 @@ TimeAndDate::TimeAndDate() { ...@@ -13,7 +13,7 @@ TimeAndDate::TimeAndDate() {
TimeAndDate::TimeAndDate(uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute, TimeAndDate::TimeAndDate(uint16_t year, uint8_t month, uint8_t day, uint8_t hour, uint8_t minute,
uint8_t second) { uint8_t second) {
// check if the parameters makes sense // check if the parameters make sense
assertI(2019 <= year, ErrorHandler::InternalErrorType::InvalidDate); assertI(2019 <= year, ErrorHandler::InternalErrorType::InvalidDate);
assertI(1 <= month && month <= 12, ErrorHandler::InternalErrorType::InvalidDate); assertI(1 <= month && month <= 12, ErrorHandler::InternalErrorType::InvalidDate);
assertI(1 <= day && day <= 31, ErrorHandler::InternalErrorType::InvalidDate); assertI(1 <= day && day <= 31, ErrorHandler::InternalErrorType::InvalidDate);
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment