imi415/openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

move improperly located documentation

Browse Source 
Somehow, the comment block for command handlers ended up associated
with the output_handler.  Move it to the command_handler_t declaration.
This commit is contained in:
Zachary T Welch 2009-11-29 16:30:00 -08:00
parent bc9ae74073
commit 3d204ec66a
1 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/helper/command.h
View File

@ -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