From 0184ddba186fa618775865792e1eda9e86d9bb91 Mon Sep 17 00:00:00 2001 From: Antonio Borneo Date: Wed, 22 Sep 2021 23:14:22 +0200 Subject: [PATCH] command: document enum command_mode Add the description to doxygen documentation. Change-Id: Iec04b4a37088e1b3b52ca84102820f450528b5b9 Signed-off-by: Antonio Borneo Reviewed-on: https://review.openocd.org/c/openocd/+/6593 Tested-by: jenkins --- src/helper/command.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/helper/command.h b/src/helper/command.h index fb9e50c85e..796cd9d3b3 100644 --- a/src/helper/command.h +++ b/src/helper/command.h @@ -38,6 +38,15 @@ #define PRINTF_ATTRIBUTE_FORMAT printf #endif +/** + * OpenOCD command mode is COMMAND_CONFIG at start, then switches to COMMAND_EXEC + * during the execution of command 'init'. + * The field 'mode' in struct command_registration specifies in which command mode + * the command can be executed: + * - during COMMAND_CONFIG only, + * - during COMMAND_EXEC only, + * - in both modes (COMMAND_ANY). + */ enum command_mode { COMMAND_EXEC, COMMAND_CONFIG, -- 2.30.2