External/cxxopts
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Jarryd Beck 2018-03-21 18:13:49 +11:00
parent 0f819a5cab
commit 16e3968e1a
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -52,6 +52,17 @@ exception will be thrown.
Note that the result of `options.parse` should only be used as long as the Note that the result of `options.parse` should only be used as long as the
`options` object that created it is in scope. `options` object that created it is in scope.
## Exceptions
Exceptional situations throw C++ exceptions. There are two types of
exceptions: errors defining the options, and errors when parsing a list of
arguments. All exceptions derive from `cxxopts::OptionException`. Errors
defining options derive from `cxxopts::OptionSpecException` and errors
parsing arguments derive from `cxxopts::OptionParseException`.
All exceptions define a `what()` function to get a printable string
explaining the error.
## Help groups ## Help groups
Options can be placed into groups for the purposes of displaying help messages. Options can be placed into groups for the purposes of displaying help messages.
@ -116,4 +127,3 @@ expressions. For example GCC >= 4.9 or clang with libc++.
# TODO list # TODO list
* Allow unrecognised options. * Allow unrecognised options.
* Various help strings.