Files
SimControl/docs/mainpage.md
Henry Winkel 147125babf Squashed 'libs/cli11/' content from commit dcbcb47
git-subtree-dir: libs/cli11
git-subtree-split: dcbcb4721dda5dab0a56d9faaaee50e6a30f7758
2022-09-15 09:51:20 +02:00

1.3 KiB

Introduction

This is the Doxygen API documentation for CLI11 parser. There is a friendly introduction to CLI11 on the GitHub page, and a tutorial series.

The main classes are:

Name Where used
CLI::Option Options, stored in the app
CLI::App The main application or subcommands
CLI::Validator A check that can affect the type name
CLI::Formatter A subclassable formatter for help printing
CLI::ExitCode A scoped enum with exit codes
CLI::Timer A timer class, only in CLI/Timer.hpp (not in CLI11.hpp)
CLI::AutoTimer A timer that prints on deletion

Groups of related topics:

Name Description
@ref error_group Errors that can be thrown
@ref validator_group Common validators used in CLI::Option::check()