From 123e0db5ee6f87395a5a653d8f6acbc267ac97d3 Mon Sep 17 00:00:00 2001 From: thodkatz <thodkatz@gmail.com> Date: Fri, 30 Nov 2018 01:38:13 +0200 Subject: [PATCH] Better documentation --- inc/Services/RequestVerificationService.hpp | 22 ++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/inc/Services/RequestVerificationService.hpp b/inc/Services/RequestVerificationService.hpp index e3828ac7..dcabc558 100644 --- a/inc/Services/RequestVerificationService.hpp +++ b/inc/Services/RequestVerificationService.hpp @@ -6,7 +6,7 @@ /** * Implementation of the ST[01] request verification service * - * Note:For the time being the cause(routing, acceptance, execution), that functions of ST[01] + * Note:For the time being, the cause(routing, acceptance, execution), that functions of ST[01] * should be called, hasn't been implemented yet. In main.cpp there are some random calls with * dummy values. * @@ -24,8 +24,8 @@ public: * TM[1,1] successful acceptance verification report * * Take a Message& reference as argument, that contains the necessary data to send the report. - * The data is actually some class variables of Message that contain the basic info of the - * telecommand packet that accepted successfully and the format is defined from the standard + * The data is actually some data members of Message that contain the basic info of the + * telecommand packet that accepted successfully * */ void successAcceptanceVerification(Message &request); @@ -34,8 +34,8 @@ public: * TM[1,2] failed acceptance verification report * * Take a Message& reference as argument, that contains the necessary data to send the report. - * The data is actually some class variables of Message that contain the basic info of the - * telecommand packet that fail to be accepted and the format is defined from the standard + * The data is actually some data members of Message that contain the basic info of the + * telecommand packet that failed to be accepted * */ void failAcceptanceVerification(Message &request); @@ -45,8 +45,8 @@ public: * TM[1,7] successful completion of execution verification report * * Take a Message& reference as argument, that contains the necessary data to send the report. - * The data is actually some class variables of Message that contain the basic info of the - * telecommand packet that executed successfully and the format is defined from the standard + * The data is actually data members of Message that contain the basic info of the + * telecommand packet that executed successfully * */ void successExecutionVerification(Message &request); @@ -55,8 +55,8 @@ public: * TM[1,8] failed completion of execution verification report * * Take a Message& reference as argument, that contains the necessary data to send the report. - * The data is actually some class variables of Message that contain the basic info of the - * telecommand packet that fail to be executed and the format is defined from the standard + * The data is actually some data members of Message that contain the basic info of the + * telecommand packet that failed to be executed * */ void failExecutionVerification(Message &request); @@ -65,8 +65,8 @@ public: * TM[1,10] failed routing verification report * * Take a Message& reference as argument, that contains the necessary data to send the report. - * The data is actually some class variables of Message that contain the basic info of the - * telecommand packet that fail the routing and the format is defined from the standard + * The data is actually some data members of Message that contain the basic info of the + * telecommand packet that failed the routing * */ void failRoutingVerification(Message &request); -- GitLab