From: Zachary T Welch <zw@superlucidity.net>
Date: Mon, 30 Nov 2009 00:30:00 +0000 (-0800)
Subject: move improperly located documentation
X-Git-Tag: v0.4.0-rc1~259
X-Git-Url: https://review.openocd.org/gitweb?a=commitdiff_plain;h=3d204ec66a840849372ab4c0ec4526a6f8557106;p=openocd.git

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 72c5647567..07235961b1 100644
--- 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