cli_command Struct Reference

CLI command structure. More...

#include <cli.h>

Data Fields
int(*	cli_command )(char **args)
const char *	cli_command_name
const char *	cli_command_brief_desc
const char *	cli_command_detailed_desc
const char *	cli_command_usage

Detailed Description

CLI command structure.

Note that the only uninitialized field can be the cli_command_detailed_desc.

Parameters

cli_command	The function pointer to executed function.
cli_command_name	The name of command by which it is called.
cli_command_description	The description of command printed by "help".
cli_command_detailed_desc	The detailed description of command printed by "help <command>".
cli_command_usage	The usage of command printed on wrong parameters.

Definition at line 23 of file cli.h.

Field Documentation

cli_command

int(* cli_command::cli_command) (char **args)

Definition at line 25 of file cli.h.

Referenced by cli_exec_line().

cli_command_brief_desc

const char* cli_command::cli_command_brief_desc

Definition at line 27 of file cli.h.

Referenced by print_help().

cli_command_detailed_desc

const char* cli_command::cli_command_detailed_desc

Definition at line 28 of file cli.h.

cli_command_name

const char* cli_command::cli_command_name

Definition at line 26 of file cli.h.

Referenced by cli_command_generator().

cli_command_usage

const char* cli_command::cli_command_usage

Definition at line 29 of file cli.h.

Referenced by print_help().

---

The documentation for this struct was generated from the following file:

• bitlab/include/cli.h