From 3d2778fdf79eeb315ace8944fd8b555b35d550d3 Mon Sep 17 00:00:00 2001 From: "Robin.Mueller" Date: Thu, 29 Oct 2020 16:45:47 +0100 Subject: [PATCH] doc update --- action/HasActionsIF.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/action/HasActionsIF.h b/action/HasActionsIF.h index a26ed588..886d0837 100644 --- a/action/HasActionsIF.h +++ b/action/HasActionsIF.h @@ -47,9 +47,10 @@ public: virtual MessageQueueId_t getCommandQueue() const = 0; /** * Execute or initialize the execution of a certain function. - * When used in conjunction with the ActionHelper class, returning - * a return code which is not equal to RETURN_OK will trigger a step reply - * with step 0. + * Returning #EXECUTION_FINISHED or a failure code, nothing else needs to + * be done. When needing more steps, return RETURN_OK and issue steps and + * completion manually. + * One "step failed" or completion report must be issued! */ virtual ReturnValue_t executeAction(ActionId_t actionId, MessageQueueId_t commandedBy, const uint8_t* data, size_t size) = 0;