From 2091f5c03725a619150e36fadbef3aa6b5201cd2 Mon Sep 17 00:00:00 2001
From: thodkatz <thodkatz@gmail.com>
Date: Thu, 24 Jan 2019 11:28:46 +0200
Subject: [PATCH] Added comments

---
 inc/ErrorHandler.hpp                        | 2 +-
 inc/Services/RequestVerificationService.hpp | 9 +++++++--
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/inc/ErrorHandler.hpp b/inc/ErrorHandler.hpp
index 781bc299..6f6d4a32 100644
--- a/inc/ErrorHandler.hpp
+++ b/inc/ErrorHandler.hpp
@@ -129,7 +129,7 @@ public:
 	};
 
 	/**
-	 * The error code for failed completion of execution reports, as specified in ECSS 6.1.3.3d
+	 * The error code for failed routing reports, as specified in ECSS 6.1.3.3d
 	 *
 	 * Note: Numbers are kept in code explicitly, so that there is no uncertainty when something
 	 * changes.
diff --git a/inc/Services/RequestVerificationService.hpp b/inc/Services/RequestVerificationService.hpp
index a1a62922..9bd35482 100644
--- a/inc/Services/RequestVerificationService.hpp
+++ b/inc/Services/RequestVerificationService.hpp
@@ -37,6 +37,7 @@ public:
 	 * @param request Contains the necessary data to send the report.
 	 * The data is actually some data members of Message that contain the basic
 	 * info of the telecommand packet that failed to be accepted
+	 * @param errorCode The cause of creating this type of report
 	 */
 	void failAcceptanceVerification(const Message &request, ErrorHandler::AcceptanceErrorType
 	errorCode);
@@ -56,6 +57,7 @@ public:
 	 * @param request Contains the necessary data to send the report.
 	 * The data is actually some data members of Message that contain the basic info
 	 * of the telecommand packet that its start of execution has failed
+	 * @param errorCode The cause of creating this type of report
 	 */
 	void failStartExecutionVerification(const Message &request,
 		ErrorHandler::StartExecutionErrorType
@@ -76,6 +78,7 @@ public:
 	 * @param request Contains the necessary data to send the report.
 	 * The data is actually some data members of Message that contain the basic info
 	 * of the telecommand packet that its progress of execution has failed
+	 * @param errorCode The cause of creating this type of report
 	 */
 	void failProgressExecutionVerification(const Message &request,
 		ErrorHandler::ProgressExecutionErrorType errorCode);
@@ -95,6 +98,7 @@ public:
 	 * @param request Contains the necessary data to send the report.
 	 * The data is actually some data members of Message that contain the basic info of the
 	 * telecommand packet that failed to be executed completely
+	 * @param errorCode The cause of creating this type of report
 	 */
 	void failCompletionExecutionVerification(const Message &request,
 		ErrorHandler::CompletionExecutionErrorType errorCode);
@@ -105,6 +109,7 @@ public:
 	 * @param request Contains the necessary data to send the report.
 	 * The data is actually some data members of Message that contain the basic info of the
 	 * telecommand packet that failed the routing
+	 * @param errorCode The cause of creating this type of report
  	 */
 	void failRoutingVerification(const Message &request, ErrorHandler::RoutingErrorType errorCode);
 
@@ -121,8 +126,8 @@ public:
 	//void execute(const Message &message);
 
 	/**
-	 *  The purpose of this instance is to access the execute function of this service when a
-	 *  MessageParser object is created
+	 * The purpose of this instance is to access the execute function of this service when a
+	 * MessageParser object is created
 	 */
 	static RequestVerificationService instance;
 };
-- 
GitLab