diff options
| author | Antonio Borneo <borneo.antonio@gmail.com> | 2021-09-22 23:14:22 +0200 |
|---|---|---|
| committer | Antonio Borneo <borneo.antonio@gmail.com> | 2021-10-25 16:10:28 +0000 |
| commit | 0184ddba186fa618775865792e1eda9e86d9bb91 (patch) | |
| tree | 8b2f1686c46e3e485a1c1e205ab6a5b6dc38868a /src/helper | |
| parent | 8f1971295b251dc13b687db493c2daa7f922e940 (diff) | |
| download | riscv-openocd-0184ddba186fa618775865792e1eda9e86d9bb91.zip riscv-openocd-0184ddba186fa618775865792e1eda9e86d9bb91.tar.gz riscv-openocd-0184ddba186fa618775865792e1eda9e86d9bb91.tar.bz2 | |
command: document enum command_mode
Add the description to doxygen documentation.
Change-Id: Iec04b4a37088e1b3b52ca84102820f450528b5b9
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/6593
Tested-by: jenkins
Diffstat (limited to 'src/helper')
| -rw-r--r-- | src/helper/command.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/src/helper/command.h b/src/helper/command.h index fb9e50c..796cd9d 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, |