idfxx::console::command Struct Reference

Command descriptor for registration. More...

Public Attributes
std::string_view	name
	Command name (required, no spaces)
std::string_view	help = {}
	Help text (empty = hidden from help)
std::string_view	hint = {}
	Hint text (empty = auto-generate from argtable)
void *	argtable = nullptr
	Optional argtable3 pointer for argument parsing.

Detailed Description

Command descriptor for registration.

Describes a command to register with the console. The name field is required and must not contain spaces. Other fields are optional.

Definition at line 60 of file console.hpp.

Member Data Documentation

argtable

void* idfxx::console::command::argtable = nullptr

Optional argtable3 pointer for argument parsing.

Definition at line 64 of file console.hpp.

help

std::string_view idfxx::console::command::help = {}

Help text (empty = hidden from help)

Definition at line 62 of file console.hpp.

hint

std::string_view idfxx::console::command::hint = {}

Hint text (empty = auto-generate from argtable)

Definition at line 63 of file console.hpp.

name

std::string_view idfxx::console::command::name

Command name (required, no spaces)

Definition at line 61 of file console.hpp.

---

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

• idfxx_console/include/idfxx/console.hpp