From d9b4854f53f96d1ff8ff76cf8604ccb997731387 Mon Sep 17 00:00:00 2001
From: athatheocsd <athatheo@csd.auth.gr>
Date: Tue, 11 Dec 2018 17:58:49 +0200
Subject: [PATCH] Minor comment additions and modifications
---
inc/Services/EventReportService.hpp | 3 +++
src/Services/EventReportService.cpp | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/inc/Services/EventReportService.hpp b/inc/Services/EventReportService.hpp
index 24cb7ee7..6c2d95ff 100644
--- a/inc/Services/EventReportService.hpp
+++ b/inc/Services/EventReportService.hpp
@@ -53,6 +53,9 @@ public:
/**
* Type of the information event
+ *
+ * Note: Numbers are kept in code explicitly, so that there is no uncertainty when something
+ * changes.
*/
enum Event {
/**
diff --git a/src/Services/EventReportService.cpp b/src/Services/EventReportService.cpp
index 7f0b7642..37a41d5c 100644
--- a/src/Services/EventReportService.cpp
+++ b/src/Services/EventReportService.cpp
@@ -81,7 +81,7 @@ void EventReportService::enableReportGeneration(uint16_t length, Event *eventID)
void EventReportService::disableReportGeneration(uint16_t length, Event *eventID) {
// TC[5,6]
/**
- * @todo: Report an error if length>numberOfEvents
+ * @todo: Report an error if length > numberOfEvents
*/
if (length <= numberOfEvents) {
for (uint16_t i = 0; i < length; i++) {
--
GitLab