custom_section_descriptor_t Struct Reference

Custom help section descriptor. More...

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

Data Fields
const char *	heading
	Section heading (e.g., "INTERACTIVE CONTROLS")
const char *	content
	Section content.
option_mode_bitmask_t	mode_bitmask
	Which modes show this section.

Detailed Description

Custom help section descriptor.

Describes a custom section to be printed in help output. Sections appear after EXAMPLES but before OPTIONS.

Definition at line 389 of file builder.h.

Field Documentation

content

const char* custom_section_descriptor_t::content

Section content.

Definition at line 391 of file builder.h.

Referenced by options_print_help_for_mode().

heading

const char* custom_section_descriptor_t::heading

Section heading (e.g., "INTERACTIVE CONTROLS")

Definition at line 390 of file builder.h.

Referenced by options_builder_add_custom_section(), and options_print_help_for_mode().

mode_bitmask

option_mode_bitmask_t custom_section_descriptor_t::mode_bitmask

Which modes show this section.

Definition at line 392 of file builder.h.

Referenced by options_print_help_for_mode().

---

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

• builder.h