aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-06-06 02:14:33 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-06-06 02:14:33 +0000
commitbe0482d01d2da8f4f13c72fa9d42ea94c80e7327 (patch)
tree3a3fa07a253bb2a1e160dca9b6af44f5a28a2211
parent3150f0b24ee988fb93e70096d39724ef28a5902c (diff)
downloadpaludis-be0482d01d2da8f4f13c72fa9d42ea94c80e7327.tar.gz
paludis-be0482d01d2da8f4f13c72fa9d42ea94c80e7327.tar.xz
Fix Doxygen grouping
-rw-r--r--paludis/args/bad_argument.hh8
-rw-r--r--paludis/args/bad_value.hh38
-rw-r--r--paludis/args/missing_value.hh15
-rw-r--r--paludis/default_environment.hh4
-rw-r--r--paludis/dep_list.hh42
-rw-r--r--paludis/util/comparison_policy.hh.m434
-rw-r--r--test/test_framework.hh2
7 files changed, 90 insertions, 53 deletions
diff --git a/paludis/args/bad_argument.hh b/paludis/args/bad_argument.hh
index 2b5e5f8..3b0e925 100644
--- a/paludis/args/bad_argument.hh
+++ b/paludis/args/bad_argument.hh
@@ -25,8 +25,8 @@
/** \file
* Declaration for BadArgument.
*
- * \ingroup Args
- * \ingroup Exception
+ * \ingroup grplibpaludisargs
+ * \ingroup grpexceptions
*/
namespace paludis
@@ -36,8 +36,8 @@ namespace paludis
/**
* Thrown if an unrecognised command line argument is specified.
*
- * \ingroup Args
- * \ingroup Exception
+ * \ingroup grplibpaludisargs
+ * \ingroup grpexceptions
*/
class BadArgument : public ArgsError
{
diff --git a/paludis/args/bad_value.hh b/paludis/args/bad_value.hh
index 386c112..0392bbc 100644
--- a/paludis/args/bad_value.hh
+++ b/paludis/args/bad_value.hh
@@ -1,5 +1,4 @@
-#ifndef PALUDIS_GUARD_ARGS_BAD_VALUE_HH
-#define PALUDIS_GUARD_ARGS_BAD_VALUE_HH 1
+/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
* Copyright (c) 2005, 2006 Ciaran McCreesh <ciaran.mccreesh@blueyonder.co.uk>
@@ -18,33 +17,36 @@
* Place, Suite 330, Boston, MA 02111-1307 USA
*/
+#ifndef PALUDIS_GUARD_ARGS_BAD_VALUE_HH
+#define PALUDIS_GUARD_ARGS_BAD_VALUE_HH 1
+
#include <paludis/args/args_error.hh>
/** \file
* Declaration for BadValue.
*
- * \ingroup Args
- * \ingroup Exception
+ * \ingroup grplibpaludisargs
+ * \ingroup grpexceptions
*/
namespace paludis
{
namespace args
{
- /**
- * Thrown if an invalid parameter is passed to a valid command line argument.
- *
- * \ingroup Args
- * \ingroup Exception
- */
- class BadValue : public ArgsError
- {
- public:
- /**
- * Constructor
- */
- BadValue(const std::string& option, const std::string& value) throw();
- };
+ /**
+ * Thrown if an invalid parameter is passed to a valid command line argument.
+ *
+ * \ingroup grplibpaludisargs
+ * \ingroup grpexceptions
+ */
+ class BadValue : public ArgsError
+ {
+ public:
+ /**
+ * Constructor
+ */
+ BadValue(const std::string& option, const std::string& value) throw();
+ };
}
}
diff --git a/paludis/args/missing_value.hh b/paludis/args/missing_value.hh
index 05a0408..9873ff0 100644
--- a/paludis/args/missing_value.hh
+++ b/paludis/args/missing_value.hh
@@ -1,7 +1,3 @@
-#ifndef PALUDIS_GUARD_PALUDIS_ARGS_MISSING_VALUE_HH
-#define PALUDIS_GUARD_PALUDIS_ARGS_MISSING_VALUE_HH 1
-
-
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
@@ -22,13 +18,16 @@
* Place, Suite 330, Boston, MA 02111-1307 USA
*/
+#ifndef PALUDIS_GUARD_PALUDIS_ARGS_MISSING_VALUE_HH
+#define PALUDIS_GUARD_PALUDIS_ARGS_MISSING_VALUE_HH 1
+
#include <paludis/args/args_error.hh>
/** \file
* Declaration for MissingValue
*
- * \ingroup Args
- * \ingroup Exception
+ * \ingroup grplibpaludisargs
+ * \ingroup grpexceptions
*/
namespace paludis
@@ -39,8 +38,8 @@ namespace paludis
* Thrown if an argument is specified that needs a parameter,
* but no parameter is given.
*
- * \ingroup Args
- * \ingroup Exception
+ * \ingroup grplibpaludisargs
+ * \ingroup grpexceptions
*/
class MissingValue : public ArgsError
{
diff --git a/paludis/default_environment.hh b/paludis/default_environment.hh
index bfad97e..59bdcd8 100644
--- a/paludis/default_environment.hh
+++ b/paludis/default_environment.hh
@@ -26,7 +26,7 @@
/** \file
* Declarations for the DefaultEnvironment class.
*
- * \ingroup Environment
+ * \ingroup grpdefaultenvironment
*/
namespace paludis
@@ -35,7 +35,7 @@ namespace paludis
* The DefaultEnvironment is an Environment that corresponds to the normal
* operating evironment.
*
- * \ingroup Environment
+ * \ingroup grpdefaultenvironment
*/
class DefaultEnvironment :
public Environment,
diff --git a/paludis/dep_list.hh b/paludis/dep_list.hh
index b93beee..9fd17a6 100644
--- a/paludis/dep_list.hh
+++ b/paludis/dep_list.hh
@@ -40,6 +40,9 @@ namespace paludis
{
/**
* Keys for a DepListEntry.
+ *
+ * \see DepListEntry
+ * \ingroup grpdepresolver
*/
enum DepListEntryKeys
{
@@ -54,6 +57,9 @@ namespace paludis
/**
* Flags for a DepListEntry.
+ *
+ * \see DepListEntry
+ * \ingroup grpdepresolver
*/
enum DepListEntryFlag
{
@@ -66,11 +72,15 @@ namespace paludis
/**
* Flags for a DepListEntry.
+ *
+ * \ingroup grpdepresolver
*/
typedef std::bitset<last_dlef> DepListEntryFlags;
/**
* Tag for a DepListEntry.
+ *
+ * \ingroup grpdepresolver
*/
struct DepListEntryTag :
SmartRecordTag<comparison_mode::EqualityComparisonTag, comparison_method::SmartRecordCompareByAllTag>,
@@ -86,16 +96,23 @@ namespace paludis
/**
* A DepListEntry represents an entry in a DepList.
+ *
+ * \ingroup grpdepresolver
*/
typedef MakeSmartRecord<DepListEntryTag>::Type DepListEntry;
/**
* A DepListEntry can be written to a stream.
+ *
+ * \ingroup grpdepresolver
*/
std::ostream & operator<< (std::ostream &, const DepListEntry &);
/**
* Thrown if an error occurs whilst building a DepList.
+ *
+ * \ingroup grpdepresolver
+ * \ingroup grpexceptions
*/
class DepListError : public Exception
{
@@ -108,6 +125,9 @@ namespace paludis
/**
* Thrown if a DepList's add stack gets too deep.
+ *
+ * \ingroup grpdepresolver
+ * \ingroup grpexceptions
*/
class DepListStackTooDeepError : public DepListError
{
@@ -120,6 +140,9 @@ namespace paludis
/**
* Thrown if no entry in a || ( ) block is resolvable.
+ *
+ * \ingroup grpdepresolver
+ * \ingroup grpexceptions
*/
class NoResolvableOptionError : public DepListError
{
@@ -138,6 +161,9 @@ namespace paludis
/**
* Thrown if all versions of a particular atom are masked.
+ *
+ * \ingroup grpdepresolver
+ * \ingroup grpexceptions
*/
class AllMaskedError : public DepListError
{
@@ -168,6 +194,9 @@ namespace paludis
/**
* Thrown if a block is encountered.
+ *
+ * \ingroup grpdepresolver
+ * \ingroup grpexceptions
*/
class BlockError : public DepListError
{
@@ -180,6 +209,9 @@ namespace paludis
/**
* Thrown if a circular dependency is encountered.
+ *
+ * \ingroup grpdepresolver
+ * \ingroup grpexceptions
*/
class CircularDependencyError : public DepListError
{
@@ -208,10 +240,12 @@ namespace paludis
};
/**
- * Used in DepList::set_rdepend_post
+ * Used in DepList::set_rdepend_post.
+ *
+ * \ingroup grpdepresolver
*/
- enum DepListRdependOption
- {
+ enum DepListRdependOption
+ {
/**
* RDEPENDs are always merged before the package; abort if this fails.
*/
@@ -231,6 +265,8 @@ namespace paludis
/**
* Holds a list of dependencies in merge order.
+ *
+ * \ingroup grpdepresolver
*/
class DepList :
private InstantiationPolicy<DepList, instantiation_method::NonCopyableTag>,
diff --git a/paludis/util/comparison_policy.hh.m4 b/paludis/util/comparison_policy.hh.m4
index 46e8206..adb0e88 100644
--- a/paludis/util/comparison_policy.hh.m4
+++ b/paludis/util/comparison_policy.hh.m4
@@ -27,7 +27,7 @@ dnl vim: set ft=cpp et sw=4 sts=4 :
/** \file
* Declarations for the ComparisonPolicy class.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
namespace paludis
@@ -35,14 +35,14 @@ namespace paludis
/**
* Comparison modes for paludis::ComparisonPolicy.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
namespace comparison_mode
{
/**
* No comparisons can be made.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
struct NoComparisonTag
{
@@ -51,7 +51,7 @@ namespace paludis
/**
* Comparisons can be made via operator== and operator!=.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
struct EqualityComparisonTag
{
@@ -60,7 +60,7 @@ namespace paludis
/**
* The full range of comparison operators is available.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
struct FullComparisonTag
{
@@ -70,14 +70,14 @@ namespace paludis
/**
* Comparison methods for paludis::ComparisonPolicy.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
namespace comparison_method
{
/**
* Comparisons are done via a member of type MemberType_.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename MemberType_>
struct CompareByMemberTag
@@ -89,7 +89,7 @@ namespace paludis
* less than zero (less than), equal to zero (equal to) or greater than
* zero (greater than).
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
struct CompareByMemberComparisonFunctionTag
{
@@ -100,7 +100,7 @@ namespace paludis
* Comparisons are done via a member function that returns an item of
* type MemberType_.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename MemberType_>
struct CompareByMemberFetchFunctionTag
@@ -113,7 +113,7 @@ namespace paludis
* ComparisonPolicy specifies the availabillity of comparison methods and
* the strategy used to do comparisons.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename OurType_, typename ComparisonModeTag_, typename ComparisonMethodTag_>
struct ComparisonPolicy
@@ -127,7 +127,7 @@ namespace paludis
/**
* ComparisonPolicy: specialisation for NoComparisonTag.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename OurType_, typename ComparisonMethodTag_>
class ComparisonPolicy<OurType_, comparison_mode::NoComparisonTag, ComparisonMethodTag_>
@@ -147,7 +147,7 @@ namespace paludis
* ComparisonPolicy: specialisation for EqualityComparisonTag +
* CompareByMemberTag.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename OurType_, typename MemberType_>
class ComparisonPolicy<OurType_, comparison_mode::EqualityComparisonTag,
@@ -195,7 +195,7 @@ make_operator(`!=')
* ComparisonPolicy: specialisation for EqualityComparisonTag +
* CompareByMemberComparisonFunctionTag.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename OurType_>
class ComparisonPolicy<OurType_, comparison_mode::EqualityComparisonTag,
@@ -243,7 +243,7 @@ make_operator(`!=')
* ComparisonPolicy: specialisation for FullComparisonTag +
* CompareByMemberTag.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename OurType_, typename MemberType_>
class ComparisonPolicy<OurType_, comparison_mode::FullComparisonTag,
@@ -295,7 +295,7 @@ make_operator(`>')
* ComparisonPolicy: specialisation for FullComparisonTag +
* CompareByMemberComparisonFunctionTag.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename OurType_>
class ComparisonPolicy<OurType_, comparison_mode::FullComparisonTag,
@@ -346,7 +346,7 @@ make_operator(`>')
* ComparisonPolicy: specialisation for EqualityComparisonTag +
* CompareByMemberFetchFunctionTag.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename OurType_, typename MemberType_>
class ComparisonPolicy<OurType_, comparison_mode::EqualityComparisonTag,
@@ -392,7 +392,7 @@ make_operator(`!=')
* ComparisonPolicy: specialisation for FullComparisonTag +
* CompareByMemberFetchFunctionTag.
*
- * \ingroup Utility
+ * \ingroup grpcompare
*/
template <typename OurType_, typename MemberType_>
class ComparisonPolicy<OurType_, comparison_mode::FullComparisonTag,
diff --git a/test/test_framework.hh b/test/test_framework.hh
index 33aa95f..8576fb4 100644
--- a/test/test_framework.hh
+++ b/test/test_framework.hh
@@ -137,7 +137,7 @@ namespace test
* Thrown if a TestCase failed.
*
* \ingroup Test
- * \ingroup Exception
+ * \ingroup grpexceptions
*/
class TestFailedException : public std::exception
{