#include <ICommandRegistry.h>

Public Attributes
const char *	name
	Sub-command keyword, e.g. "LIST". nullptr terminates the array.
const char *	args
	Argument hint shown in HELP, e.g. "<ns> <key>". May be "" or nullptr.
const char *	help
	One-line description.
CommandHandler	handler
	Invoked with the args following the sub-command keyword.

Detailed Description

Sub-command descriptor.

Used to attach a list of sub-commands to a top-level Command. The registry uses this for help output; dispatch is done with dispatchSubCommand() from SubCommand.h, which walks the same table.

Definition at line 21 of file ICommandRegistry.h.

Member Data Documentation

◆ args

const char* cdc::serial::SubCommand::args

Argument hint shown in HELP, e.g. "<ns> <key>". May be "" or nullptr.

Definition at line 23 of file ICommandRegistry.h.

◆ handler

CommandHandler cdc::serial::SubCommand::handler

Invoked with the args following the sub-command keyword.

Definition at line 25 of file ICommandRegistry.h.

◆ help

const char* cdc::serial::SubCommand::help

One-line description.

Definition at line 24 of file ICommandRegistry.h.

◆ name

const char* cdc::serial::SubCommand::name

Sub-command keyword, e.g. "LIST". nullptr terminates the array.

Definition at line 22 of file ICommandRegistry.h.

Referenced by cdc::serial::dispatchSubCommand(), cdc::serial::printSubCommandHelp(), and cdc::serial::CommandRegistry::showHelp().

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

components/serial_cmd/include/serial_cmd/ICommandRegistry.h