move improperly located documentation

Somehow, the comment block for command handlers ended up associated
with the output_handler.  Move it to the command_handler_t declaration.

diff --git a/src/helper/command.h b/src/helper/command.h
index 72c5647567dbb01d29349649da7924677633b298..07235961b1ddc236f215432864bee3d1755c29b7 100644 (file)
--- a/src/helper/command.h
+++ b/src/helper/command.h
@@ -62,20 +62,6 @@ struct command_context
        enum command_mode mode;
        struct command *commands;
        int current_target;
-       /* Execute a command.
-        *
-        * If the command fails, it *MUST* return a value != ERROR_OK
-        * (many commands break this rule, patches welcome!)
-        *
-        * This is *especially* important for commands such as writing
-        * to flash or verifying memory. The reason is that those commands
-        * can be used by programs to determine if the operation succeded
-        * or not. If the operation failed, then a program can try
-        * an alternative approach.
-        *
-        * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
-        * printing out the syntax of the command.
-        */
        command_output_handler_t output_handler;
        void *output_handler_priv;
 };
@@ -166,7 +152,23 @@ struct command_invocation {
 #define CMD_DATA CMD_CURRENT->jim_handler_data
 
 
-/// The type signature for commands' handler functions.
+/**
+ * The type signature for command handling functions.  They are
+ * usually registered as part of command_registration, providing
+ * a high-level means for executing a command.
+ *
+ * If the command fails, it *MUST* return a value != ERROR_OK
+ * (many commands break this rule, patches welcome!)
+ *
+ * This is *especially* important for commands such as writing
+ * to flash or verifying memory. The reason is that those commands
+ * can be used by programs to determine if the operation succeded
+ * or not. If the operation failed, then a program can try
+ * an alternative approach.
+ *
+ * Returning ERROR_COMMAND_SYNTAX_ERROR will have the effect of
+ * printing out the syntax of the command.
+ */
 typedef __COMMAND_HANDLER((*command_handler_t));
 
 struct command