Skip to content
Snippets Groups Projects
Unverified Commit adaa87c8 authored by kongr45gpen's avatar kongr45gpen
Browse files

Move some TODOs as doxygen comments

Apply suggestion to src/Helpers/TimeAndDate.cpp
parent a5b58582
No related branches found
No related tags found
No related merge requests found
...@@ -76,13 +76,14 @@ private: ...@@ -76,13 +76,14 @@ private:
* *
* @details All scheduled activities must contain the request they exist for, their release * @details All scheduled activities must contain the request they exist for, their release
* time and the corresponding request identifier. * time and the corresponding request identifier.
*
* @todo If we decide to use sub-schedules, the ID of that has to be defined
* @todo If groups are used, then the group ID has to be defined here
*/ */
struct ScheduledActivity { struct ScheduledActivity {
Message request; ///< Hold the received command request Message request; ///< Hold the received command request
RequestID requestID; ///< Request ID, characteristic of the definition RequestID requestID; ///< Request ID, characteristic of the definition
uint32_t requestReleaseTime = 0; ///< Keep the command release time uint32_t requestReleaseTime = 0; ///< Keep the command release time
// todo: If we decide to use sub-schedules, the ID of that has to be defined
// todo: If groups are used, then the group ID has to be defined here
}; };
/** /**
......
...@@ -17,6 +17,7 @@ TimeAndDate::TimeAndDate(uint16_t year, uint8_t month, uint8_t day, uint8_t hour ...@@ -17,6 +17,7 @@ TimeAndDate::TimeAndDate(uint16_t year, uint8_t month, uint8_t day, uint8_t hour
ASSERT_INTERNAL((1 <= day) && (day <= 31), ErrorHandler::InternalErrorType::InvalidDate); ASSERT_INTERNAL((1 <= day) && (day <= 31), ErrorHandler::InternalErrorType::InvalidDate);
ASSERT_INTERNAL(hour < 24, ErrorHandler::InternalErrorType::InvalidDate); ASSERT_INTERNAL(hour < 24, ErrorHandler::InternalErrorType::InvalidDate);
ASSERT_INTERNAL(minute < 60, ErrorHandler::InternalErrorType::InvalidDate); ASSERT_INTERNAL(minute < 60, ErrorHandler::InternalErrorType::InvalidDate);
// Seconds can be equal to 60, to account for leap seconds.
ASSERT_INTERNAL(second <= 60, ErrorHandler::InternalErrorType::InvalidDate); ASSERT_INTERNAL(second <= 60, ErrorHandler::InternalErrorType::InvalidDate);
this->year = year; this->year = year;
......
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