aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTaylor C. Richberger <Taywee@gmx.com>2016-05-10 09:20:22 -0600
committerTaylor C. Richberger <Taywee@gmx.com>2016-05-10 09:20:22 -0600
commit82317fd388e59c4f408491667010e253735750c3 (patch)
tree3bf51a0169199da696873485ea9d8d60ea6a632c
parentremove pointless friends (diff)
downloadargs.hxx-82317fd388e59c4f408491667010e253735750c3.tar.xz
improve doxygen
-rw-r--r--args.hxx9
1 files changed, 9 insertions, 0 deletions
diff --git a/args.hxx b/args.hxx
index f4f6be9..b232a44 100644
--- a/args.hxx
+++ b/args.hxx
@@ -19,6 +19,12 @@
* IN THE SOFTWARE.
*/
+/** \file args.hxx
+ * \brief this single-header lets you use all of the args functionality
+ *
+ * The important stuff is done inside the args namespace
+ */
+
#include <algorithm>
#include <exception>
#include <functional>
@@ -29,6 +35,9 @@
#include <unordered_set>
#include <type_traits>
+/** \namespace args
+ * \brief contains all the functionality of the args library
+ */
namespace args
{
/** Getter to grab the value reference