From be529bf58a29b466e146dc86bcede668f0ec3244 Mon Sep 17 00:00:00 2001
From: Theodoros Katzalis <thodkatz@gmail.com>
Date: Mon, 18 Mar 2019 13:02:23 +0200
Subject: [PATCH] Minor changes in the documentation
---
inc/Helpers/TimeAndDate.hpp | 15 ++++++---------
src/Helpers/TimeAndDate.cpp | 2 +-
2 files changed, 7 insertions(+), 10 deletions(-)
diff --git a/inc/Helpers/TimeAndDate.hpp b/inc/Helpers/TimeAndDate.hpp
index 39281373..8ddc5669 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 a0a02c68..d0a5fc7d 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);
--
GitLab