From 4557a2eb361abf6de9fc1ca49908ae4421504fcb Mon Sep 17 00:00:00 2001 From: "Robin.Mueller" Date: Thu, 29 Oct 2020 13:34:53 +0100 Subject: [PATCH] better comments --- action/ActionHelper.h | 5 +++-- action/SimpleActionHelper.cpp | 3 ++- action/SimpleActionHelper.h | 3 +++ 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/action/ActionHelper.h b/action/ActionHelper.h index 17ca3ebd..a91722f3 100644 --- a/action/ActionHelper.h +++ b/action/ActionHelper.h @@ -57,8 +57,9 @@ public: * @param commandId ID of the executed command * @param result Result of the execution */ - void step(uint8_t step, MessageQueueId_t reportTo, ActionId_t commandId, - ReturnValue_t result = HasReturnvaluesIF::RETURN_OK); + void step(uint8_t step, MessageQueueId_t reportTo, + ActionId_t commandId, + ReturnValue_t result = HasReturnvaluesIF::RETURN_OK); /** * Function to be called by the owner to send a action completion message * diff --git a/action/SimpleActionHelper.cpp b/action/SimpleActionHelper.cpp index 1ab4f476..af57736c 100644 --- a/action/SimpleActionHelper.cpp +++ b/action/SimpleActionHelper.cpp @@ -10,7 +10,8 @@ SimpleActionHelper::~SimpleActionHelper() { } void SimpleActionHelper::step(ReturnValue_t result) { - //STEP_OFFESET is subtracted to compensate for adding offset in base method, which is not necessary here. + // STEP_OFFESET is subtracted to compensate for adding offset in base + // method, which is not necessary here. ActionHelper::step(stepCount - STEP_OFFSET, lastCommander, lastAction, result); if (result != HasReturnvaluesIF::RETURN_OK) { diff --git a/action/SimpleActionHelper.h b/action/SimpleActionHelper.h index d401cdc1..1f35d9fd 100644 --- a/action/SimpleActionHelper.h +++ b/action/SimpleActionHelper.h @@ -4,6 +4,9 @@ #include "ActionHelper.h" /** + * @brief This is an action helper which is only able to service one action + * at a time but remembers last commander and last action which + * simplifies usage */ class SimpleActionHelper: public ActionHelper { public: