command: document enum command_mode

[fw/openocd] / src / helper / command.h

diff --git a/src/helper/command.h b/src/helper/command.h
index fb9e50c85e86728ad4b0c7f8512b11d73a103828..796cd9d3b3860b10f465d0627ca9ad00cd4a5b10 100644 (file)
--- 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,