aboutsummaryrefslogtreecommitdiff
path: root/args.hxx
diff options
context:
space:
mode:
authorTaylor C. Richberger <Taywee@gmx.com>2016-05-10 09:23:05 -0600
committerTaylor C. Richberger <Taywee@gmx.com>2016-05-10 09:23:05 -0600
commit17a43e3973c72a12cdd51feace4f505e2494f132 (patch)
treeb1cc8a71a4e210c0c7d85fde15fe717231b71a2f /args.hxx
parentimprove doxygen (diff)
downloadargs.hxx-17a43e3973c72a12cdd51feace4f505e2494f132.tar.xz
improve documentation
Diffstat (limited to 'args.hxx')
-rw-r--r--args.hxx5
1 files changed, 4 insertions, 1 deletions
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 <typename Arg>
auto get(Arg &arg) -> decltype(arg.Get())