From 17a43e3973c72a12cdd51feace4f505e2494f132 Mon Sep 17 00:00:00 2001 From: "Taylor C. Richberger" Date: Tue, 10 May 2016 09:23:05 -0600 Subject: improve documentation --- README.md | 6 ++++-- args.hxx | 5 ++++- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1246367..f7c6d26 100644 --- a/README.md +++ b/README.md @@ -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? diff --git a/args.hxx b/args.hxx index b232a44..752dc7b 100644 --- a/args.hxx +++ b/args.hxx @@ -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 auto get(Arg &arg) -> decltype(arg.Get()) -- cgit v1.2.1