1
0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-04-29 12:13:52 +00:00
CLI11/docs/mainpage.md
2022-05-10 13:47:38 -04: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()