1
0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-05-01 13:13:53 +00:00
CLI11/docs/mainpage.md
Henry Fredrick Schreiner 18b3fa9dfe Adding more docs
2017-03-22 11:13:23 -04:00

932 B

Introduction

This is the Doxygen API documentation for CLI11 parser. There is a friendly introduction to CLI11 on the Github page.

The main classes are:

Name Where used
CLI::Option Options, stored in the app
CLI::App The main application or subcommands
CLI::ExitCodes A scoped enum with exit codes
CLI::Timer A timer class, only in CLI/Timer.hpp (not 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()