1
0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-04-30 20:53:52 +00:00
CLI11/docs/mainpage.md
Henry Fredrick Schreiner ce6c942008 Adding doxygen docs
2017-02-15 09:35:54 -05:00

22 lines
747 B
Markdown

# Introduction
This is the Doxygen API documentation for CLI11 parser. There is a friendly introduction to CLI11 on the [Github page](https://github.com/henryiii/CLI11).
The main classes are:
| Name | Where used |
|---------------|-------------------------------------|
|CLI::Option | Options, stored in the app |
|CLI::App | The main application or subcommands |
Groups of related topics:
| Name | Description |
|----------------------|------------------------------------------------|
| @ref error_group | Errors that can be thrown |
| @ref validator_group | Common validators used in CLI::Option::check() |