usage_descriptor_t Struct Reference

The complete registry entry for one command-line/configuration option. More...

#include <include/ascii-chat/options/builder.h>

Data Fields
const char *	mode
	NULL or mode name (e.g., "server") or "<mode>" placeholder.
const char *	positional
	NULL or positional args (e.g., "[bind-addr]", "<session-string>").
bool	show_options
	true = show "[options...]" suffix
const char *	description
	Help text for this usage pattern.

Detailed Description

The complete registry entry for one command-line/configuration option.

Usage line descriptor for programmatic USAGE generation

Stores components separately so colors can be applied semantically:

• mode: magenta
• positional args: green
• options: yellow

Definition at line 307 of file builder.h.

Field Documentation

description

const char* usage_descriptor_t::description

Help text for this usage pattern.

Definition at line 311 of file builder.h.

mode

const char* usage_descriptor_t::mode

NULL or mode name (e.g., "server") or "<mode>" placeholder.

Definition at line 308 of file builder.h.

positional

const char* usage_descriptor_t::positional

NULL or positional args (e.g., "[bind-addr]", "<session-string>").

Definition at line 309 of file builder.h.

show_options

bool usage_descriptor_t::show_options

true = show "[options...]" suffix

Definition at line 310 of file builder.h.

---

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

• builder.h