1
0
mirror of https://github.com/profanity-im/profanity.git synced 2024-12-04 14:46:46 -05:00

Updated Command structure comments

This commit is contained in:
James Booth 2016-04-27 00:03:24 +01:00
parent d4aa73159e
commit ce32814679

View File

@ -50,10 +50,12 @@ typedef struct cmd_help_t {
* Command structure * Command structure
* *
* cmd - The command string including leading '/' * cmd - The command string including leading '/'
* func - The function to execute for the command
* parser - The function used to parse arguments * parser - The function used to parse arguments
* min_args - Minimum number of arguments * min_args - Minimum number of arguments
* max_args - Maximum number of arguments * max_args - Maximum number of arguments
* setting_func - Function to display current settings to the console
* sub_funcs - Optional list of functions mapped to the first argument
* func - Main function to call when no arguments, or sub_funcs not implemented
* help - A help struct containing usage info etc * help - A help struct containing usage info etc
*/ */
typedef struct cmd_t { typedef struct cmd_t {