diff options
author | Taylor C. Richberger <Taywee@gmx.com> | 2016-05-10 09:23:05 -0600 |
---|---|---|
committer | Taylor C. Richberger <Taywee@gmx.com> | 2016-05-10 09:23:05 -0600 |
commit | 17a43e3973c72a12cdd51feace4f505e2494f132 (patch) | |
tree | b1cc8a71a4e210c0c7d85fde15fe717231b71a2f | |
parent | improve doxygen (diff) | |
download | args.hxx-17a43e3973c72a12cdd51feace4f505e2494f132.tar.xz |
improve documentation
-rw-r--r-- | README.md | 6 | ||||
-rw-r--r-- | args.hxx | 5 |
2 files changed, 8 insertions, 3 deletions
@@ -112,8 +112,10 @@ documentation. Then you can either call it with args::ArgumentParser::ParseCLI for the full command line with program name, or args::ArgumentParser::ParseArgs with just the arguments to be parsed. The argument and group variables can then be -interpreted as a boolean to see if they've been matched, and their arguments -can be pulled from their value and values attributes, if applicable. +interpreted as a boolean to see if they've been matched. + +All variables can be pulled (including the boolean match status) with +args::get. # How fast is it? @@ -40,7 +40,10 @@ */ namespace args { - /** Getter to grab the value reference + /** Getter to grab the value from the argument type. + * + * If the Get() function of the type returns a reference, so does this, and + * the value will be modifiable. */ template <typename Arg> auto get(Arg &arg) -> decltype(arg.Get()) |