example_descriptor_t Struct Reference

Example descriptor for programmatic EXAMPLES generation. More...

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

Data Fields
uint32_t	mode_bitmask
	Bitmask of modes (OPTION_MODE_SERVER, OPTION_MODE_CLIENT, etc.)
const char *	args
	Command-line arguments part of the example.
const char *	description
bool	owns_args_memory
	True if args memory should be freed by options_config_destroy.
bool	is_utility_command
	True if this is a utility command (don't prepend program name)

Detailed Description

Example descriptor for programmatic EXAMPLES generation.

Stores command components separately for semantic coloring:

• mode_bitmask: which modes this example applies to
• args: green

Definition at line 310 of file builder.h.

Field Documentation

args

const char* example_descriptor_t::args

Command-line arguments part of the example.

Definition at line 312 of file builder.h.

Referenced by manpage_content_generate_examples(), options_builder_add_example(), options_builder_add_example_utility(), and options_config_calculate_max_col_width().

description

const char* example_descriptor_t::description

Definition at line 313 of file builder.h.

Referenced by manpage_content_generate_examples().

is_utility_command

bool example_descriptor_t::is_utility_command

True if this is a utility command (don't prepend program name)

Definition at line 315 of file builder.h.

Referenced by options_config_calculate_max_col_width().

mode_bitmask

uint32_t example_descriptor_t::mode_bitmask

Bitmask of modes (OPTION_MODE_SERVER, OPTION_MODE_CLIENT, etc.)

Definition at line 311 of file builder.h.

Referenced by manpage_content_generate_examples(), options_builder_add_example(), options_builder_add_example_utility(), and options_config_calculate_max_col_width().

owns_args_memory

bool example_descriptor_t::owns_args_memory

True if args memory should be freed by options_config_destroy.

Definition at line 314 of file builder.h.

---

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

• builder.h