lector::Configuration Struct Reference

Configuration of the help information of a collection of command line arguments. More...

#include <arguments.hpp>

Public Attributes
std::optional< std::string >	description {std::nullopt}
	Description of the application whose command line arguments are to be parsed. When the collection of command line arguments' help information is printed, this description appears between its usage information and its options information. Optional and empty by default, in which case no description is printed.
std::optional< std::string >	notes {std::nullopt}
	Additional notes pertaining to the application whose command line arguments are to be parsed. When the collection of command line arguments' help information is printed, these notes appear last, after its options information. Optional and empty by default, in which case no notes are printed.
std::optional< std::string >	title {std::nullopt}
	Title of the application whose command line arguments are to be parsed. When the collection of command line arguments' help information is printed, this title appears first, before its usage information. Optional and empty by default, in which case no title is printed.

Detailed Description

Configuration of the help information of a collection of command line arguments.

Member Data Documentation

description

std::optional<std::string> lector::Configuration::description {std::nullopt}

Description of the application whose command line arguments are to be parsed. When the collection of command line arguments' help information is printed, this description appears between its usage information and its options information. Optional and empty by default, in which case no description is printed.

notes

std::optional<std::string> lector::Configuration::notes {std::nullopt}

Additional notes pertaining to the application whose command line arguments are to be parsed. When the collection of command line arguments' help information is printed, these notes appear last, after its options information. Optional and empty by default, in which case no notes are printed.

title

std::optional<std::string> lector::Configuration::title {std::nullopt}

Title of the application whose command line arguments are to be parsed. When the collection of command line arguments' help information is printed, this title appears first, before its usage information. Optional and empty by default, in which case no title is printed.

---

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

• lector/arguments.hpp