aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-09 17:16:47 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-09 17:16:47 +0000
commit330b0a02bb290f67f4e4fa5afd0f096c226ec7eb (patch)
tree6ae38a2037c231e3fb986e862e52e6f0a0847e74
parent32d751c9001d5d6aa457b49348c420ecf2f8cc51 (diff)
downloadpaludis-330b0a02bb290f67f4e4fa5afd0f096c226ec7eb.tar.gz
paludis-330b0a02bb290f67f4e4fa5afd0f096c226ec7eb.tar.xz
More doxygen
-rw-r--r--paludis/args/args.cc8
-rw-r--r--paludis/args/args.hh8
-rw-r--r--paludis/args/args_dumper.cc6
-rw-r--r--paludis/args/args_dumper.hh14
-rw-r--r--paludis/args/args_error.cc9
-rw-r--r--paludis/args/args_error.hh22
-rw-r--r--paludis/args/args_group.cc6
-rw-r--r--paludis/args/args_group.hh10
-rw-r--r--paludis/args/args_handler.cc6
-rw-r--r--paludis/args/args_handler.hh12
-rw-r--r--paludis/args/args_option.cc31
-rw-r--r--paludis/args/args_option.hh20
-rw-r--r--paludis/args/args_visitor.cc6
-rw-r--r--paludis/args/args_visitor.hh12
-rw-r--r--paludis/args/bad_argument.cc9
-rw-r--r--paludis/args/bad_argument.hh15
16 files changed, 78 insertions, 116 deletions
diff --git a/paludis/args/args.cc b/paludis/args/args.cc
index 510351d..3f4464c 100644
--- a/paludis/args/args.cc
+++ b/paludis/args/args.cc
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2005, 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -19,9 +19,3 @@
#include "args.hh"
-/** \file
- * Implementation for args.hh .
- *
- * \ingroup grplibpaludisargs
- */
-
diff --git a/paludis/args/args.hh b/paludis/args/args.hh
index 8aad3bd..7811734 100644
--- a/paludis/args/args.hh
+++ b/paludis/args/args.hh
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2005, 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -23,7 +23,11 @@
/** \file
* Master include file for command line argument handling.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
+ *
+ * \section Examples
+ *
+ * - None at this time.
*/
#include <paludis/args/args_error.hh>
diff --git a/paludis/args/args_dumper.cc b/paludis/args/args_dumper.cc
index f92059a..5eacfc4 100644
--- a/paludis/args/args_dumper.cc
+++ b/paludis/args/args_dumper.cc
@@ -23,12 +23,6 @@
#include <sstream>
-/** \file
- * Implementation of ArgsDumper.
- *
- * \ingroup grplibpaludisargs
- */
-
using namespace paludis;
using namespace paludis::args;
diff --git a/paludis/args/args_dumper.hh b/paludis/args/args_dumper.hh
index c0fa70e..60a7f27 100644
--- a/paludis/args/args_dumper.hh
+++ b/paludis/args/args_dumper.hh
@@ -24,6 +24,16 @@
#include <paludis/args/args_visitor.hh>
#include <paludis/util/visitor.hh>
+/** \file
+ * Declarations for the ArgsDumper class.
+ *
+ * \ingroup g_args
+ *
+ * \section Examples
+ *
+ * - None at this time.
+ */
+
namespace paludis
{
namespace args
@@ -36,9 +46,9 @@ namespace paludis
class EnumArg;
/**
- * Visitor class. Prints help text appropriate to each command line option.
+ * Prints help text appropriate to each command line option.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
*/
class PALUDIS_VISIBLE ArgsDumper :
public ConstVisitor<ArgsVisitorTypes>
diff --git a/paludis/args/args_error.cc b/paludis/args/args_error.cc
index 36f9ee4..6785170 100644
--- a/paludis/args/args_error.cc
+++ b/paludis/args/args_error.cc
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2005, 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -19,13 +19,6 @@
#include "args_error.hh"
-/** \file
- * Implementation for ArgsError.
- *
- * \ingroup grplibpaludisargs
- * \ingroup grpexceptions
- */
-
using namespace paludis::args;
ArgsError::ArgsError(const std::string & our_message) throw () :
diff --git a/paludis/args/args_error.hh b/paludis/args/args_error.hh
index 2f5b631..e66249e 100644
--- a/paludis/args/args_error.hh
+++ b/paludis/args/args_error.hh
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2005, 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -24,9 +24,13 @@
#include <string>
/** \file
- * Declaration for ArgsError.
+ * Declarations for argument exception classes.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
+ *
+ * \section Examples
+ *
+ * - None at this time.
*/
namespace paludis
@@ -36,8 +40,8 @@ namespace paludis
/**
* Thrown if an invalid command line argument is provided.
*
- * \ingroup grplibpaludisargs
- * \ingroup grpexceptions
+ * \ingroup g_exceptions
+ * \ingroup g_args
*/
class PALUDIS_VISIBLE ArgsError :
public paludis::Exception
@@ -52,8 +56,8 @@ namespace paludis
/**
* Thrown if an invalid parameter is passed to a valid command line argument.
*
- * \ingroup grplibpaludisargs
- * \ingroup grpexceptions
+ * \ingroup g_args
+ * \ingroup g_exceptions
*/
class PALUDIS_VISIBLE BadValue :
public ArgsError
@@ -69,8 +73,8 @@ namespace paludis
* Thrown if an argument is specified that needs a parameter,
* but no parameter is given.
*
- * \ingroup grplibpaludisargs
- * \ingroup grpexceptions
+ * \ingroup g_args
+ * \ingroup g_exceptions
*/
class PALUDIS_VISIBLE MissingValue :
public ArgsError
diff --git a/paludis/args/args_group.cc b/paludis/args/args_group.cc
index ea12a86..032cb95 100644
--- a/paludis/args/args_group.cc
+++ b/paludis/args/args_group.cc
@@ -21,12 +21,6 @@
#include <paludis/util/private_implementation_pattern-impl.hh>
#include <list>
-/** \file
- * Implementation for ArgsGroup.
- *
- * \ingroup grplibpaludisargs
- */
-
using namespace paludis::args;
namespace paludis
diff --git a/paludis/args/args_group.hh b/paludis/args/args_group.hh
index 5b4b6ec..39c6d5a 100644
--- a/paludis/args/args_group.hh
+++ b/paludis/args/args_group.hh
@@ -28,9 +28,13 @@
#include <libwrapiter/libwrapiter_forward_iterator-fwd.hh>
/** \file
- * Declaration for ArgsGroup.
+ * Declarations for ArgsGroup.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
+ *
+ * \section Examples
+ *
+ * - None at this time.
*/
namespace paludis
@@ -43,7 +47,7 @@ namespace paludis
/**
* Contains a related group of command line arguments.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
* \nosubgrouping
*/
class PALUDIS_VISIBLE ArgsGroup :
diff --git a/paludis/args/args_handler.cc b/paludis/args/args_handler.cc
index 055cb99..df18aa2 100644
--- a/paludis/args/args_handler.cc
+++ b/paludis/args/args_handler.cc
@@ -29,12 +29,6 @@
#include <list>
#include <map>
-/** \file
- * Implementation for ArgsHandler.
- *
- * \ingroup grplibpaludisargs
- */
-
using namespace paludis::args;
namespace paludis
diff --git a/paludis/args/args_handler.hh b/paludis/args/args_handler.hh
index 3d8bf8f..797c531 100644
--- a/paludis/args/args_handler.hh
+++ b/paludis/args/args_handler.hh
@@ -30,9 +30,13 @@
#include <libwrapiter/libwrapiter_forward_iterator-fwd.hh>
/** \file
- * Declaration for ArgsHandler.
+ * Declarations for ArgsHandler.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
+ *
+ * \section Examples
+ *
+ * - None at this time.
*/
namespace paludis
@@ -42,7 +46,7 @@ namespace paludis
/**
* Handles command line arguments.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
* \nosubgrouping
*/
class PALUDIS_VISIBLE ArgsHandler :
@@ -190,7 +194,7 @@ namespace paludis
/**
* Output an ArgsHandler to an ostream, for --help output.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
*/
std::ostream & operator<< (std::ostream &, const ArgsHandler &) PALUDIS_VISIBLE;
}
diff --git a/paludis/args/args_option.cc b/paludis/args/args_option.cc
index bab8dec..ddfc2cf 100644
--- a/paludis/args/args_option.cc
+++ b/paludis/args/args_option.cc
@@ -24,22 +24,11 @@
#include <vector>
#include <algorithm>
-/** \file
- * Implementation for ArgsOption.
- *
- * \ingroup grplibpaludisargs
- */
-
using namespace paludis;
using namespace paludis::args;
namespace
{
- /**
- * Is an arg a particular value?
- *
- * \ingroup grplibpaludisargs
- */
struct ArgIs
{
/// The argument.
@@ -116,11 +105,6 @@ StringArg::StringArg(ArgsGroup * const g, const std::string & our_long_name,
namespace paludis
{
- /**
- * Implementation data for StringSetArg.
- *
- * \ingroup grplibpaludisargs
- */
template<>
struct Implementation<StringSetArg>
{
@@ -128,11 +112,6 @@ namespace paludis
std::vector<std::pair<std::string, std::string> > allowed_args;
};
- /**
- * Implementation data for StringSetArg::StringSetArgOptions.
- *
- * \ingroup grplibpaludisargs
- */
template<>
struct Implementation<StringSetArg::StringSetArgOptions>
{
@@ -198,22 +177,12 @@ IntegerArg::IntegerArg(ArgsGroup * const our_group, const std::string & our_long
namespace paludis
{
- /**
- * Implementation data for EnumArg.
- *
- * \ingroup grplibpaludisargs
- */
template<>
struct Implementation<EnumArg>
{
std::vector<std::pair<std::string, std::string> > allowed_args;
};
- /**
- * Implementation data for EnumArg::EnumArgOptions.
- *
- * \ingroup grplibpaludisargs
- */
template<>
struct Implementation<EnumArg::EnumArgOptions>
{
diff --git a/paludis/args/args_option.hh b/paludis/args/args_option.hh
index 8c28d48..f9dbbc4 100644
--- a/paludis/args/args_option.hh
+++ b/paludis/args/args_option.hh
@@ -25,9 +25,13 @@
#include <paludis/util/private_implementation_pattern.hh>
/** \file
- * Declaration for ArgsOption.
+ * Declarations for ArgsOption.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
+ *
+ * \section Examples
+ *
+ * - None at this time.
*/
namespace paludis
@@ -39,7 +43,7 @@ namespace paludis
/**
* Base class for a command line option.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
*/
class PALUDIS_VISIBLE ArgsOption :
public virtual AcceptInterface<ArgsVisitorTypes>
@@ -130,7 +134,7 @@ namespace paludis
* A SwitchArg is an option that can either be specified or not
* specified, and that takes no value (for example, --help).
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
*/
class PALUDIS_VISIBLE SwitchArg :
public ArgsOption,
@@ -149,7 +153,7 @@ namespace paludis
/**
* An option that takes a string argument.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
*/
class PALUDIS_VISIBLE StringArg :
public ArgsOption,
@@ -187,7 +191,7 @@ namespace paludis
/**
* An option that takes a set of strings.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
* \nosubgrouping
*/
class PALUDIS_VISIBLE StringSetArg :
@@ -286,7 +290,7 @@ namespace paludis
/**
* An AliasArg is an alias for another argument.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
*/
class PALUDIS_VISIBLE AliasArg :
public ArgsOption,
@@ -352,7 +356,7 @@ namespace paludis
/**
* An option that takes one of a predefined set of string arguments.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
* \nosubgrouping
*/
class PALUDIS_VISIBLE EnumArg :
diff --git a/paludis/args/args_visitor.cc b/paludis/args/args_visitor.cc
index 245de48..e90f0ec 100644
--- a/paludis/args/args_visitor.cc
+++ b/paludis/args/args_visitor.cc
@@ -29,12 +29,6 @@
#include <sstream>
#include <stdlib.h>
-/** \file
- * Implementation for ArgsVisitor.
- *
- * \ingroup grplibpaludisargs
- */
-
using namespace paludis;
using namespace paludis::args;
diff --git a/paludis/args/args_visitor.hh b/paludis/args/args_visitor.hh
index ecbf94e..aa7907a 100644
--- a/paludis/args/args_visitor.hh
+++ b/paludis/args/args_visitor.hh
@@ -28,9 +28,13 @@
#include <libwrapiter/libwrapiter_forward_iterator.hh>
/** \file
- * Declaration for ArgsVisitor
+ * Declarations for ArgsVisitor.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
+ *
+ * \section Examples
+ *
+ * - None at this time.
*/
namespace paludis
@@ -48,7 +52,7 @@ namespace paludis
/**
* Visitor types for visitors that can visit Args.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
*/
struct ArgsVisitorTypes :
VisitorTypes<
@@ -66,7 +70,7 @@ namespace paludis
/**
* Visitor class. Processes command-line options as they are found.
*
- * \ingroup grplibpaludisargs
+ * \ingroup g_args
*/
class PALUDIS_VISIBLE ArgsVisitor :
public Visitor<ArgsVisitorTypes>
diff --git a/paludis/args/bad_argument.cc b/paludis/args/bad_argument.cc
index 4aa1167..9619142 100644
--- a/paludis/args/bad_argument.cc
+++ b/paludis/args/bad_argument.cc
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2005, 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -19,13 +19,6 @@
#include "bad_argument.hh"
-/** \file
- * Implementation for BadArgument.
- *
- * \ingroup grplibpaludisargs
- * \ingroup grpexceptions
- */
-
using namespace paludis::args;
BadArgument::BadArgument(const std::string & option) throw () :
diff --git a/paludis/args/bad_argument.hh b/paludis/args/bad_argument.hh
index 92660e8..d88e3a5 100644
--- a/paludis/args/bad_argument.hh
+++ b/paludis/args/bad_argument.hh
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2005, 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -23,10 +23,13 @@
#include <paludis/args/args_error.hh>
/** \file
- * Declaration for BadArgument.
+ * Declarations for BadArgument.
*
- * \ingroup grplibpaludisargs
- * \ingroup grpexceptions
+ * \ingroup g_args
+ *
+ * \section Examples
+ *
+ * - None at this time.
*/
namespace paludis
@@ -36,8 +39,8 @@ namespace paludis
/**
* Thrown if an unrecognised command line argument is specified.
*
- * \ingroup grplibpaludisargs
- * \ingroup grpexceptions
+ * \ingroup g_args
+ * \ingroup g_exceptions
*/
class PALUDIS_VISIBLE BadArgument :
public ArgsError