aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-10-13 14:07:34 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-10-13 14:07:34 +0000
commitd0d90fd4424cb181af360bcafb70ba5d09984c49 (patch)
tree5852a605c40c5aed5508aa5ef155b2a24e6ef02a
parent1ccf8fc4d1dcc8809e68e14b174b0c74e6f73455 (diff)
downloadpaludis-d0d90fd4424cb181af360bcafb70ba5d09984c49.tar.gz
paludis-d0d90fd4424cb181af360bcafb70ba5d09984c49.tar.xz
Doxygen updates
-rw-r--r--Makefile.am2
-rw-r--r--doc/doxygen.conf.in11
-rw-r--r--paludis/about_TEST.cc3
-rw-r--r--paludis/args/args_TEST.cc4
-rw-r--r--paludis/args/bad_argument.cc4
-rw-r--r--paludis/config_file_TEST.cc9
-rw-r--r--paludis/dep_atom_TEST.cc4
-rw-r--r--paludis/dep_list.hh64
-rw-r--r--paludis/dep_list_TEST.cc63
-rw-r--r--paludis/dep_tag.hh3
-rw-r--r--paludis/digests/md5_TEST.cc2
-rw-r--r--paludis/digests/rmd160_TEST.cc2
-rw-r--r--paludis/digests/sha256_TEST.cc3
-rw-r--r--paludis/environment.hh6
-rw-r--r--paludis/environment/default/default_config.hh6
-rw-r--r--paludis/environment/no_config/no_config_environment.hh5
-rw-r--r--paludis/hashed_containers_TEST.cc1
-rw-r--r--paludis/libxml/libxml.hh17
-rw-r--r--paludis/name_TEST.cc9
-rw-r--r--paludis/package_database.hh5
-rw-r--r--paludis/package_database_TEST.cc4
-rw-r--r--paludis/paludis.hh.m44
-rw-r--r--paludis/portage_dep_lexer_TEST.cc8
-rw-r--r--paludis/portage_dep_parser_TEST.cc12
-rw-r--r--paludis/qa/changelog_check.hh5
-rw-r--r--paludis/qa/check.hh4
-rw-r--r--paludis/qa/check_result.hh4
-rw-r--r--paludis/qa/create_metadata_check.hh5
-rw-r--r--paludis/qa/defaults_check.hh5
-rw-r--r--paludis/qa/dep_any_check.hh5
-rw-r--r--paludis/qa/dep_flags_check.hh5
-rw-r--r--paludis/qa/dep_packages_check.hh5
-rw-r--r--paludis/qa/deprecated_functions_check.hh5
-rw-r--r--paludis/qa/deps_exist_check.hh5
-rw-r--r--paludis/qa/deps_visible_check.hh5
-rw-r--r--paludis/qa/description_check.hh5
-rw-r--r--paludis/qa/digest_collisions_check.hh5
-rw-r--r--paludis/qa/ebuild_check.hh18
-rw-r--r--paludis/qa/ebuild_count_check.hh5
-rw-r--r--paludis/qa/extract_check.hh5
-rw-r--r--paludis/qa/file_check.hh22
-rw-r--r--paludis/qa/file_permissions_check.hh5
-rw-r--r--paludis/qa/filename_check.hh5
-rw-r--r--paludis/qa/files_dir_size_check.hh5
-rw-r--r--paludis/qa/glep_31_check.hh5
-rw-r--r--paludis/qa/gpg_check.hh5
-rw-r--r--paludis/qa/has_ebuilds_check.hh5
-rw-r--r--paludis/qa/has_misc_files_check.hh5
-rw-r--r--paludis/qa/homepage_check.hh5
-rw-r--r--paludis/qa/inherits_check.hh5
-rw-r--r--paludis/qa/iuse_check.hh5
-rw-r--r--paludis/qa/keywords_check.hh5
-rw-r--r--paludis/qa/license_check.hh5
-rw-r--r--paludis/qa/message.hh12
-rw-r--r--paludis/qa/metadata_check.hh5
-rw-r--r--paludis/qa/metadata_file.hh5
-rw-r--r--paludis/qa/package_dir_check.hh22
-rw-r--r--paludis/qa/package_name_check.hh5
-rw-r--r--paludis/qa/parse_deps_check.hh5
-rw-r--r--paludis/qa/pdepend_overlap_check.hh5
-rw-r--r--paludis/qa/qa_environment.hh5
-rw-r--r--paludis/qa/restrict_check.hh5
-rw-r--r--paludis/qa/slot_check.hh5
-rw-r--r--paludis/qa/src_uri_check.hh5
-rw-r--r--paludis/qa/whitespace_check.hh5
-rw-r--r--paludis/repositories/cran/cran_dep_parser_TEST.cc2
-rw-r--r--paludis/repositories/fake/fake_installed_repository.hh5
-rw-r--r--paludis/repositories/fake/fake_repository.hh5
-rw-r--r--paludis/repositories/portage/glsa.hh16
-rw-r--r--paludis/repositories/portage/portage_repository_TEST.cc18
-rw-r--r--paludis/repositories/portage/portage_repository_profile_file.hh7
-rw-r--r--paludis/repositories/vdb/vdb_repository_TEST.cc4
-rw-r--r--paludis/repositories/virtuals/installed_virtuals_repository.hh5
-rw-r--r--paludis/repositories/virtuals/virtuals_repository.hh5
-rw-r--r--paludis/tasks/install_task.hh15
-rw-r--r--paludis/tasks/sync_task.hh5
-rw-r--r--paludis/tasks/uninstall_task.hh10
-rw-r--r--paludis/test_extras.cc4
-rw-r--r--paludis/util/attributes.hh.in20
-rw-r--r--paludis/util/counted_ptr_TEST.cc15
-rw-r--r--paludis/util/destringify_TEST.cc5
-rw-r--r--paludis/util/instantiation_policy_TEST.cc5
-rw-r--r--paludis/util/is_file_with_extension_TEST.cc3
-rw-r--r--paludis/util/iterator_TEST.cc11
-rw-r--r--paludis/util/join_TEST.cc4
-rw-r--r--paludis/util/log.hh5
-rw-r--r--paludis/util/pstream_TEST.cc5
-rw-r--r--paludis/util/random_TEST.cc2
-rw-r--r--paludis/util/save_TEST.cc2
-rw-r--r--paludis/util/sr.hh15
-rw-r--r--paludis/util/stringify_TEST.cc6
-rw-r--r--paludis/util/strip_TEST.cc5
-rw-r--r--paludis/util/system_TEST.cc8
-rw-r--r--paludis/util/test_extras.cc1
-rw-r--r--paludis/util/tokeniser_TEST.cc3
-rw-r--r--paludis/util/virtual_constructor_TEST.cc3
-rw-r--r--paludis/util/visitor_TEST.cc3
-rw-r--r--paludis/version_operator_TEST.cc4
-rw-r--r--paludis/version_spec_TEST.cc9
-rw-r--r--test/test_fail_TEST.cc2
-rw-r--r--test/test_framework.cc2
-rw-r--r--test/test_framework.hh10
-rw-r--r--test/test_pass_TEST.cc4
-rw-r--r--test/test_runner.cc2
104 files changed, 473 insertions, 290 deletions
diff --git a/Makefile.am b/Makefile.am
index e587cc3..b5a4677 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -5,7 +5,7 @@ AUTOMAKE_OPTIONS = dist-bzip2 no-dist-gzip std-options
EXTRA_DIST = autogen.bash automake-deps-hack.tmp
SUBDIRS = misc test paludis cran ebuild ruby src doc hooks eselect
-DISTCHECK_CONFIGURE_FLAGS = --enable-qa --enable-ruby --enable-glsa --with-ruby-install-dir='$${prefix}/ruby_dir'
+DISTCHECK_CONFIGURE_FLAGS = --enable-qa --enable-ruby --enable-glsa --with-ruby-install-dir='$${DESTDIR}$${prefix}/ruby_dir'
automake-deps-hack.tmp :
$(MAKE) -C paludis/util
diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in
index 4e12a4d..5d61cb9 100644
--- a/doc/doxygen.conf.in
+++ b/doc/doxygen.conf.in
@@ -204,6 +204,15 @@ OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to
+# include (a tag file for) the STL sources as input, then you should
+# set this tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string); v.s.
+# func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+
+BUILTIN_STL_SUPPORT = YES
+
# Set the SUBGROUPING tag to YES (the default) to allow class member groups of
# the same type (for instance a group of public functions) to be put as a
# subgroup of that type (e.g. under the Public Functions section). Set it to
@@ -452,7 +461,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ../paludis ../paludis/args ../paludis/util ../paludis/digests ../paludis/selinux ../paludis/qa/ ../paludis/repositories ../paludis/repositories/nothing ../paludis/repositories/portage ../paludis/repositories/vdb ../paludis/repositories/fake ../paludis/repositories/cran ../paludis/repositories/virtuals ../test ../doc
+INPUT = ../paludis ../paludis/libxml ../paludis/digests ../paludis/tasks ../paludis/environment ../paludis/environment/no_config ../paludis/environment/test ../paludis/environment/default ../paludis/qa ../paludis/selinux ../paludis/util ../paludis/repositories ../paludis/repositories/cran ../paludis/repositories/virtuals ../paludis/repositories/portage ../paludis/repositories/fake ../paludis/repositories/vdb ../paludis/repositories/nothing ../paludis/args ../doc ../test
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
diff --git a/paludis/about_TEST.cc b/paludis/about_TEST.cc
index f79ac7e..5815b5f 100644
--- a/paludis/about_TEST.cc
+++ b/paludis/about_TEST.cc
@@ -28,7 +28,6 @@ using namespace paludis;
* \file
* Test cases for about.hh .
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -36,7 +35,6 @@ namespace test_cases
/**
* \test Version tests.
*
- * \ingroup grptestcases
*/
struct VersionTest : TestCase
{
@@ -65,7 +63,6 @@ namespace test_cases
/**
* \test Build info tests.
*
- * \ingroup grptestcases
*/
struct BuildInfoTest : TestCase
{
diff --git a/paludis/args/args_TEST.cc b/paludis/args/args_TEST.cc
index 56193ae..ad17690 100644
--- a/paludis/args/args_TEST.cc
+++ b/paludis/args/args_TEST.cc
@@ -29,7 +29,6 @@ using namespace test;
/** \file
* Test cases for paludis::args things.
*
- * \ingroup grptestcases
*/
#ifndef DOXYGEN
@@ -101,7 +100,6 @@ namespace test_cases
/**
* \test Simple args tests.
*
- * \ingroup grptestcases
*/
struct ArgsTestSimple : TestCase
{
@@ -137,7 +135,6 @@ namespace test_cases
/**
* \test Missing parameters tests.
*
- * \ingroup grptestcases
*/
struct ArgsTestNoParam : TestCase
{
@@ -154,7 +151,6 @@ namespace test_cases
/**
* \test String tests.
*
- * \ingroup grptestcases
*/
struct ArgsTestStringSet : TestCase
{
diff --git a/paludis/args/bad_argument.cc b/paludis/args/bad_argument.cc
index e2a9618..4aa1167 100644
--- a/paludis/args/bad_argument.cc
+++ b/paludis/args/bad_argument.cc
@@ -22,8 +22,8 @@
/** \file
* Implementation for BadArgument.
*
- * \ingroup Args
- * \ingroup Exception
+ * \ingroup grplibpaludisargs
+ * \ingroup grpexceptions
*/
using namespace paludis::args;
diff --git a/paludis/config_file_TEST.cc b/paludis/config_file_TEST.cc
index b4abcd1..ffaa09e 100644
--- a/paludis/config_file_TEST.cc
+++ b/paludis/config_file_TEST.cc
@@ -33,7 +33,6 @@ using namespace paludis;
/** \file
* Test cases for config_file.hh .
*
- * \ingroup grptestcases
* \ingroup grpconfigfile
*/
@@ -42,7 +41,6 @@ namespace
/**
* A ConfigFile descendent for use in tests.
*
- * \ingroup grptestcases
*/
class TestFile : protected ConfigFile
{
@@ -92,7 +90,6 @@ namespace test_cases
/**
* \test Test ConfigFile.
*
- * \ingroup grptestcases
*/
struct ConfigFileTest : TestCase
{
@@ -123,7 +120,6 @@ namespace test_cases
/**
* \test Test ConfigFile with file opening.
*
- * \ingroup grptestcases
*/
struct ConfigFileOpenFileTest : TestCase
{
@@ -155,7 +151,6 @@ namespace test_cases
/**
* \test Test LineConfigFile.
*
- * \ingroup grptestcases
*/
struct LineConfigFileTest : TestCase
{
@@ -188,7 +183,6 @@ namespace test_cases
/**
* \test Test KeyValueConfigFile basics.
*
- * \ingroup grptestcases
*/
struct KeyValueConfigFileTest : TestCase
{
@@ -216,7 +210,6 @@ namespace test_cases
/**
* \test Test KeyValueConfigFile continuations.
*
- * \ingroup grptestcases
*/
struct KeyValueConfigFileContinuationsTest : TestCase
{
@@ -237,7 +230,6 @@ namespace test_cases
/**
* \test Test KeyValueConfigFile variables.
*
- * \ingroup grptestcases
*/
struct KeyValueConfigFileVarsTest : TestCase
{
@@ -283,7 +275,6 @@ namespace test_cases
/**
* \test Test KeyValueConfigFile errors.
*
- * \ingroup grptestcases
*/
struct KeyValueConfigFileErrorsTest : TestCase
{
diff --git a/paludis/dep_atom_TEST.cc b/paludis/dep_atom_TEST.cc
index 2565dc5..a472c43 100644
--- a/paludis/dep_atom_TEST.cc
+++ b/paludis/dep_atom_TEST.cc
@@ -24,7 +24,6 @@
/** \file
* Test cases for dep_atom.hh classes.
*
- * \ingroup grptestcases
*/
using namespace paludis;
@@ -35,7 +34,6 @@ namespace test_cases
/**
* \test Test DepAtom as_ functions.
*
- * \ingroup grptestcases
*/
struct DepAtomAsTest : TestCase
{
@@ -55,7 +53,6 @@ namespace test_cases
/**
* \test Test DepAtom composite functions.
*
- * \ingroup grptestcases
*/
struct DepAtomCompositeTest : TestCase
{
@@ -79,7 +76,6 @@ namespace test_cases
/**
* \test Test PackageDepAtom.
*
- * \ingroup grptestcases
*/
struct PackageDepAtomTest : TestCase
{
diff --git a/paludis/dep_list.hh b/paludis/dep_list.hh
index f87b833..d176c25 100644
--- a/paludis/dep_list.hh
+++ b/paludis/dep_list.hh
@@ -35,45 +35,75 @@
namespace paludis
{
+ /**
+ * What type of target are we handling at the top level.
+ *
+ * \ingroup grpdepresolver
+ */
enum DepListTargetType
{
- dl_target_package,
- dl_target_set
+ dl_target_package, ///\< A package, so force reinstalls.
+ dl_target_set ///\< A set, so don't force reinstalls.
};
+ /**
+ * When should we reinstall.
+ *
+ * \ingroup grpdepresolver
+ */
enum DepListReinstallOption
{
- dl_reinstall_never,
- dl_reinstall_always,
- dl_reinstall_if_use_changed
+ dl_reinstall_never, ///\< Never.
+ dl_reinstall_always, ///\< Always.
+ dl_reinstall_if_use_changed ///\< If a USE flag has changed.
};
+ /**
+ * When should we upgrade.
+ *
+ * \ingroup grpdepresolver
+ */
enum DepListUpgradeOption
{
- dl_upgrade_always,
- dl_upgrade_as_needed
+ dl_upgrade_always, ///\< Always.
+ dl_upgrade_as_needed ///\< Only as needed.
};
+ /**
+ * How should we handle a dep class.
+ *
+ * \ingroup grpdepresolver
+ */
enum DepListDepsOption
{
- dl_deps_discard,
- dl_deps_pre,
- dl_deps_pre_or_post,
- dl_deps_post,
- dl_deps_try_post
+ dl_deps_discard, ///\< Discard it
+ dl_deps_pre, ///\< As a pre dependency
+ dl_deps_pre_or_post, ///\< As a pre dependency with fallback to post
+ dl_deps_post, ///\< As a post dependency
+ dl_deps_try_post ///\< As an optional post dependency
};
+ /**
+ * How we handle circular deps.
+ *
+ * \ingroup grpdepresolver
+ */
enum DepListCircularOption
{
- dl_circular_error,
- dl_circular_discard
+ dl_circular_error, ///\< As an error
+ dl_circular_discard ///\< Discard them
};
+ /**
+ * State of a DepListEntry.
+ *
+ * \ingroup grpdepresolver
+ */
enum DepListEntryState
{
- dle_no_deps,
- dle_has_pre_deps,
- dle_has_all_deps
+ dle_no_deps, ///\< Dependencies have yet to be added
+ dle_has_pre_deps, ///\< Predependencies have been added
+ dle_has_all_deps ///\< All dependencies have been added
};
#include <paludis/dep_list-sr.hh>
diff --git a/paludis/dep_list_TEST.cc b/paludis/dep_list_TEST.cc
index c24a4f6..47108f9 100644
--- a/paludis/dep_list_TEST.cc
+++ b/paludis/dep_list_TEST.cc
@@ -47,7 +47,6 @@ namespace test_cases
/**
* Convenience base class used by many of the DepList tests.
*
- * \ingroup Test
*/
class DepListTestCaseBase :
public TestCase
@@ -126,7 +125,6 @@ namespace test_cases
/**
* Convenience sub base class used by the numbered DepList tests.
*
- * \ingroup Test
*/
template <int i_>
struct DepListTestCase : DepListTestCaseBase
@@ -143,7 +141,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase1 : DepListTestCase<1>
{
@@ -162,7 +159,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase2 : DepListTestCase<2>
{
@@ -183,7 +179,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase3 : DepListTestCase<3>
{
@@ -206,7 +201,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase4 : DepListTestCase<4>
{
@@ -229,7 +223,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase5 : DepListTestCase<5>
{
@@ -252,7 +245,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase6 : DepListTestCase<6>
{
@@ -275,7 +267,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase7 : DepListTestCase<7>
{
@@ -300,7 +291,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase8 : DepListTestCase<8>
{
@@ -325,7 +315,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase9 : DepListTestCase<9>
{
@@ -350,7 +339,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase10 : DepListTestCase<10>
{
@@ -372,7 +360,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase11 : DepListTestCase<11>
{
@@ -396,7 +383,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase12 : DepListTestCase<12>
{
@@ -420,7 +406,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase13 : DepListTestCase<13>
{
@@ -445,7 +430,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase14 : DepListTestCase<14>
{
@@ -466,7 +450,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase15 : DepListTestCase<15>
{
@@ -488,7 +471,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase16 : DepListTestCase<16>
{
@@ -511,7 +493,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase17 : DepListTestCase<17>
{
@@ -536,7 +517,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase18 : DepListTestCase<18>
{
@@ -555,7 +535,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase19 : DepListTestCase<19>
{
@@ -576,7 +555,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase20 : DepListTestCase<20>
{
@@ -596,7 +574,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase21 : DepListTestCase<21>
{
@@ -616,7 +593,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase22 : DepListTestCase<22>
{
@@ -637,7 +613,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase23 : DepListTestCase<23>
{
@@ -659,7 +634,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase24 : DepListTestCase<24>
{
@@ -681,7 +655,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase25 : DepListTestCase<25>
{
@@ -703,7 +676,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase26 : DepListTestCase<26>
{
@@ -725,7 +697,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase27 : DepListTestCase<27>
{
@@ -747,7 +718,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase28 : DepListTestCase<28>
{
@@ -769,7 +739,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase29 : DepListTestCase<29>
{
@@ -791,7 +760,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase30 : DepListTestCase<30>
{
@@ -813,7 +781,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase31 : DepListTestCase<31>
{
@@ -835,7 +802,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase32 : DepListTestCase<32>
{
@@ -858,7 +824,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase33 : DepListTestCase<33>
{
@@ -881,7 +846,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase34 : DepListTestCase<34>
{
@@ -903,7 +867,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase35 : DepListTestCase<35>
{
@@ -925,7 +888,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase36 : DepListTestCase<36>
{
@@ -947,7 +909,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase37 : DepListTestCase<37>
{
@@ -968,7 +929,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase38 : DepListTestCase<38>
{
@@ -988,7 +948,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase39 : DepListTestCase<39>
{
@@ -1015,7 +974,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase40 : DepListTestCase<40>
{
@@ -1043,7 +1001,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase41 : DepListTestCase<41>
{
@@ -1066,7 +1023,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase42 : DepListTestCase<42>
{
@@ -1088,7 +1044,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase43 : DepListTestCase<43>
{
@@ -1110,7 +1065,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase44 : DepListTestCase<44>
{
@@ -1131,7 +1085,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase45 : DepListTestCase<45>
{
@@ -1152,7 +1105,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase46 : DepListTestCase<46>
{
@@ -1173,7 +1125,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase47 : DepListTestCase<47>
{
@@ -1200,7 +1151,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase48 : DepListTestCase<48>
{
@@ -1227,7 +1177,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase49 : DepListTestCase<49>
{
@@ -1248,7 +1197,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase50 : DepListTestCase<50>
{
@@ -1269,7 +1217,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase51 : DepListTestCase<51>
{
@@ -1296,7 +1243,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase52 : DepListTestCase<52>
{
@@ -1323,7 +1269,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase53 : DepListTestCase<53>
{
@@ -1344,7 +1289,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase54 : DepListTestCase<54>
{
@@ -1367,7 +1311,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase55 : DepListTestCase<55>
{
@@ -1388,7 +1331,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase56 : DepListTestCase<56>
{
@@ -1411,7 +1353,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase57 : DepListTestCase<57>
{
@@ -1434,7 +1375,6 @@ namespace test_cases
/**
* \test Test DepList resolution behaviour.
*
- * \ingroup Test
*/
struct DepListTestCase58 : DepListTestCase<58>
{
@@ -1454,7 +1394,6 @@ namespace test_cases
/**
* \test Test DepList transactional add behaviour.
*
- * \ingroup Test
*/
struct DepListTestCaseTransactionalAdd : TestCase
{
@@ -1489,7 +1428,6 @@ namespace test_cases
/**
* \test Test DepList transactional add behaviour on PDEPENDs.
*
- * \ingroup Test
*/
struct DepListTestCaseTransactionalAddPost : TestCase
{
@@ -1524,7 +1462,6 @@ namespace test_cases
/**
* \test Test DepList transactional forced downgrade of installed package behaviour.
*
- * \ingroup Test
*/
struct DepListTestCaseForcedDowngradeOfInstalled : TestCase
{
diff --git a/paludis/dep_tag.hh b/paludis/dep_tag.hh
index d897e8d..7edce7d 100644
--- a/paludis/dep_tag.hh
+++ b/paludis/dep_tag.hh
@@ -272,6 +272,9 @@ namespace paludis
#include <paludis/dep_tag-sr.hh>
+ /**
+ * Tags attached to a DepListEntry.
+ */
typedef SortedCollection<DepTagEntry> DepListEntryTags;
}
diff --git a/paludis/digests/md5_TEST.cc b/paludis/digests/md5_TEST.cc
index cb4f86e..a839963 100644
--- a/paludis/digests/md5_TEST.cc
+++ b/paludis/digests/md5_TEST.cc
@@ -28,7 +28,6 @@ namespace
{
/**
* \name Test utilities
- * \ingroup grptestcases
* \{
*/
@@ -65,7 +64,6 @@ namespace test_cases
{
/**
* \name Test cases for paludis::digests::MD5
- * \ingroup grptestcases
* \{
*/
diff --git a/paludis/digests/rmd160_TEST.cc b/paludis/digests/rmd160_TEST.cc
index d9e33dc..5ae5bd9 100644
--- a/paludis/digests/rmd160_TEST.cc
+++ b/paludis/digests/rmd160_TEST.cc
@@ -28,7 +28,6 @@ namespace
{
/**
* \name Test utilities
- * \ingroup grptestcases
* \{
*/
@@ -65,7 +64,6 @@ namespace test_cases
{
/**
* \name Test cases for paludis::digests::RMD160
- * \ingroup grptestcases
* \{
*/
diff --git a/paludis/digests/sha256_TEST.cc b/paludis/digests/sha256_TEST.cc
index 794a4ea..542b1da 100644
--- a/paludis/digests/sha256_TEST.cc
+++ b/paludis/digests/sha256_TEST.cc
@@ -27,14 +27,12 @@ using namespace paludis;
/** \file
* Test cases for paludis::digests::SHA256.
*
- * \ingroup grptestcases
*/
namespace
{
/**
* \name Test utilities
- * \ingroup grptestcases
* \{
*/
@@ -71,7 +69,6 @@ namespace test_cases
{
/**
* \name Test cases for paludis::digests::SHA256
- * \ingroup grptestcases
* \{
*/
diff --git a/paludis/environment.hh b/paludis/environment.hh
index 75924d8..ce5e0ea 100644
--- a/paludis/environment.hh
+++ b/paludis/environment.hh
@@ -36,6 +36,12 @@ namespace paludis
{
struct EnvironmentMirrorIteratorTag;
+ /**
+ * Iterate over environment mirrors.
+ *
+ * \see Environment
+ * \ingroup grpenvironment
+ */
typedef libwrapiter::ForwardIterator<EnvironmentMirrorIteratorTag,
const std::pair<const std::string, std::string> > EnvironmentMirrorIterator;
diff --git a/paludis/environment/default/default_config.hh b/paludis/environment/default/default_config.hh
index 03a09f5..69f1224 100644
--- a/paludis/environment/default/default_config.hh
+++ b/paludis/environment/default/default_config.hh
@@ -39,6 +39,12 @@ namespace paludis
{
struct EnvironmentMirrorIteratorTag;
+ /**
+ * Iterate over environment mirrors.
+ *
+ * \see Environment
+ * \ingroup grpenvironment
+ */
typedef libwrapiter::ForwardIterator<EnvironmentMirrorIteratorTag,
const std::pair<const std::string, std::string> > EnvironmentMirrorIterator;
diff --git a/paludis/environment/no_config/no_config_environment.hh b/paludis/environment/no_config/no_config_environment.hh
index 37837f1..c4af3a8 100644
--- a/paludis/environment/no_config/no_config_environment.hh
+++ b/paludis/environment/no_config/no_config_environment.hh
@@ -29,6 +29,11 @@ namespace paludis
{
#include <paludis/environment/no_config/no_config_environment-sr.hh>
+ /**
+ * An environment that uses a single repository, with no user configuration.
+ *
+ * \ingroup grpnoconfigenvironment
+ */
class PALUDIS_VISIBLE NoConfigEnvironment :
private PrivateImplementationPattern<NoConfigEnvironment>,
public Environment
diff --git a/paludis/hashed_containers_TEST.cc b/paludis/hashed_containers_TEST.cc
index bd60664..b6d2f4a 100644
--- a/paludis/hashed_containers_TEST.cc
+++ b/paludis/hashed_containers_TEST.cc
@@ -29,7 +29,6 @@ namespace test_cases
/**
* \test Test HashSet.
*
- * \ingroup grptestcases
*/
struct HashSetTestQPN : TestCase
{
diff --git a/paludis/libxml/libxml.hh b/paludis/libxml/libxml.hh
index 7f53a85..2797b87 100644
--- a/paludis/libxml/libxml.hh
+++ b/paludis/libxml/libxml.hh
@@ -26,6 +26,13 @@
namespace paludis
{
+ /**
+ * Wrapper around libxml pointers.
+ *
+ * RAII, the specified function is used to free the pointer.
+ *
+ * \ingroup grpxml
+ */
template <typename PtrType_>
class LibXmlPtrHolder
{
@@ -55,9 +62,19 @@ namespace paludis
}
};
+ /**
+ * Turn a retarded libxml string into a std::string.
+ *
+ * \ingroup grpxml
+ */
std::string
retarded_libxml_string_to_string(const xmlChar * s) PALUDIS_VISIBLE;
+ /**
+ * Remove leading and trailing whitespace, and normalise internal whitespace.
+ *
+ * \ingroup grpxml
+ */
std::string normalise(const std::string & s) PALUDIS_VISIBLE;
}
diff --git a/paludis/name_TEST.cc b/paludis/name_TEST.cc
index 1f4b15f..c988ceb 100644
--- a/paludis/name_TEST.cc
+++ b/paludis/name_TEST.cc
@@ -28,7 +28,6 @@ using namespace paludis;
/** \file
* Test cases for QualifiedPackageName.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -36,7 +35,6 @@ namespace test_cases
/**
* \test Basic QualifiedPackageName tests.
*
- * \ingroup grptestcases
*/
struct QualifiedPackageNameTest : TestCase
{
@@ -52,7 +50,6 @@ namespace test_cases
/**
* \test Validate QualifiedPackageName tests.
*
- * \ingroup grptestcases
*/
struct QualifiedPackageNameValidateTest : TestCase
{
@@ -70,7 +67,6 @@ namespace test_cases
/**
* \test Compare QualifiedPackageName tests.
*
- * \ingroup grptestcases
*/
struct QualifiedPackageNameCompareTest : TestCase
{
@@ -101,7 +97,6 @@ namespace test_cases
/**
* \test Test CategoryNamePart creation.
*
- * \ingroup grptestcases
*/
struct CategoryNamePartCreationTest : public TestCase
{
@@ -117,7 +112,6 @@ namespace test_cases
/**
* \test Test CategoryNamePart validation
*
- * \ingroup grptestcases
*/
struct CategoryNamePartValidationTest : public TestCase
{
@@ -136,7 +130,6 @@ namespace test_cases
/**
* \test Test PackageNamePart creation.
*
- * \ingroup grptestcases
*/
struct PackageNamePartCreationTest : public TestCase
{
@@ -152,7 +145,6 @@ namespace test_cases
/**
* \test Test PackageNamePart validation.
*
- * \ingroup grptestcases
*/
struct PackageNamePartValidationTest : public TestCase
{
@@ -171,7 +163,6 @@ namespace test_cases
/**
* \test Test PackageNamePart comparison.
*
- * \ingroup grptestcases
*/
struct PackageNamePartComparisonTest : public TestCase
{
diff --git a/paludis/package_database.hh b/paludis/package_database.hh
index b9991e1..20f2aee 100644
--- a/paludis/package_database.hh
+++ b/paludis/package_database.hh
@@ -293,6 +293,11 @@ namespace paludis
///\}
};
+ /**
+ * Write an InstallState to a stream.
+ *
+ * \ingroup grppackagedatabase
+ */
std::ostream &
operator<< (std::ostream &, const InstallState &) PALUDIS_VISIBLE;
}
diff --git a/paludis/package_database_TEST.cc b/paludis/package_database_TEST.cc
index 496f0f2..7005ae2 100644
--- a/paludis/package_database_TEST.cc
+++ b/paludis/package_database_TEST.cc
@@ -29,7 +29,6 @@ using namespace test;
/** \file
* Test cases for package_database.hh.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -37,7 +36,6 @@ namespace test_cases
/**
* \test PackageDatabase repository tests.
*
- * \ingroup grptestcases
*/
struct PackageDatabaseRepositoryTest : TestCase
{
@@ -94,7 +92,6 @@ namespace test_cases
/**
* \test PackageDatabase query tests.
*
- * \ingroup grptestcases
*/
struct PackageDatabaseQueryTest : TestCase
{
@@ -157,7 +154,6 @@ namespace test_cases
/**
* \test PackageDatabase disambiguate tests.
*
- * \ingroup grptestcases
*/
struct PackageDatabaseDisambiguateTest : TestCase
{
diff --git a/paludis/paludis.hh.m4 b/paludis/paludis.hh.m4
index 847b5e6..d97d282 100644
--- a/paludis/paludis.hh.m4
+++ b/paludis/paludis.hh.m4
@@ -39,7 +39,9 @@ include(`paludis/files.m4')
extern "C"
{
- /* for simplifying extconf.rb detection */
+ /**
+ * For simplifying extconf.rb detection.
+ */
void paludis_was_here();
}
diff --git a/paludis/portage_dep_lexer_TEST.cc b/paludis/portage_dep_lexer_TEST.cc
index a6c4694..15e2b9c 100644
--- a/paludis/portage_dep_lexer_TEST.cc
+++ b/paludis/portage_dep_lexer_TEST.cc
@@ -28,7 +28,6 @@ using namespace paludis;
/** \file
* Test cases for PortageDepLexer.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -36,7 +35,6 @@ namespace test_cases
/**
* \test Test PortageDepLexer with an empty input.
*
- * \ingroup grptestcases
*/
struct PortageDepLexerEmptyTest : TestCase
{
@@ -53,7 +51,6 @@ namespace test_cases
/**
* \test Test PortageDepLexer with a blank input.
*
- * \ingroup grptestcases
*/
struct PortageDepLexerBlankTest : TestCase
{
@@ -73,7 +70,6 @@ namespace test_cases
/**
* \test Test PortageDepLexer with a package.
*
- * \ingroup grptestcases
*/
struct PortageDepLexerPackageTest : TestCase
{
@@ -93,7 +89,6 @@ namespace test_cases
/**
* \test Test DepParser with a sequence of packages.
*
- * \ingroup grptestcases
*/
struct PortageDepLexerPackagesTest : TestCase
{
@@ -131,7 +126,6 @@ namespace test_cases
/**
* \test Test PortageDepLexer with an any group.
*
- * \ingroup grptestcases
*/
struct PortageDepLexerAnyTest : TestCase
{
@@ -185,7 +179,6 @@ namespace test_cases
/**
* \test Test PortageDepLexer with a use group.
*
- * \ingroup grptestcases
*/
struct PortageDepLexerUseTest : TestCase
{
@@ -231,7 +224,6 @@ namespace test_cases
/**
* \test Test PortageDepLexer with bad input.
*
- * \ingroup grptestcases
*/
struct PortageDepLexerBadTest : TestCase
{
diff --git a/paludis/portage_dep_parser_TEST.cc b/paludis/portage_dep_parser_TEST.cc
index 3433aab..d375cb0 100644
--- a/paludis/portage_dep_parser_TEST.cc
+++ b/paludis/portage_dep_parser_TEST.cc
@@ -28,7 +28,6 @@ using namespace paludis;
/** \file
* Test cases for PortageDepParser.
*
- * \ingroup grptestcases
*/
#ifndef DOXYGEN
@@ -119,7 +118,6 @@ namespace test_cases
/**
* \test Test PortageDepParser with an empty input.
*
- * \ingroup grptestcases
*/
struct PortageDepParserEmptyTest : TestCase
{
@@ -137,7 +135,6 @@ namespace test_cases
/**
* \test Test PortageDepParser with a blank input.
*
- * \ingroup grptestcases
*/
struct PortageDepParserBlankTest : TestCase
{
@@ -155,7 +152,6 @@ namespace test_cases
/**
* \test Test PortageDepParser with a package.
*
- * \ingroup grptestcases
*/
struct PortageDepParserPackageTest : TestCase
{
@@ -173,7 +169,6 @@ namespace test_cases
/**
* \test Test PortageDepParser with a decorated package.
*
- * \ingroup grptestcases
*/
struct PortageDepParserDecoratedPackageTest : TestCase
{
@@ -204,7 +199,6 @@ namespace test_cases
/**
* \test Test PortageDepParser with a sequence of packages.
*
- * \ingroup grptestcases
*/
struct PortageDepParserPackagesTest : TestCase
{
@@ -223,7 +217,6 @@ namespace test_cases
/**
* \test Test PortageDepParser with an any group.
*
- * \ingroup grptestcases
*/
struct PortageDepParserAnyTest : TestCase
{
@@ -242,7 +235,6 @@ namespace test_cases
/**
* \test Test PortageDepParser with an all group.
*
- * \ingroup grptestcases
*/
struct PortageDepParserAllTest : TestCase
{
@@ -261,7 +253,6 @@ namespace test_cases
/**
* \test Test PortageDepParser with a use group.
*
- * \ingroup grptestcases
*/
struct PortageDepParserUseTest : TestCase
{
@@ -280,7 +271,6 @@ namespace test_cases
/**
* \test Test PortageDepParser with an inverse use group.
*
- * \ingroup grptestcases
*/
struct PortageDepParserInvUseTest : TestCase
{
@@ -299,7 +289,6 @@ namespace test_cases
/**
* \test Test PortageDepParser nesting errors.
*
- * \ingroup grptestcases
*/
struct PortageDepParserBadNestingTest : TestCase
{
@@ -320,7 +309,6 @@ namespace test_cases
/**
* \test Test PortageDepParser weird errors.
*
- * \ingroup grptestcases
*/
struct PortageDepParserBadValuesTest : TestCase
{
diff --git a/paludis/qa/changelog_check.hh b/paludis/qa/changelog_check.hh
index 72fade5..8da85e9 100644
--- a/paludis/qa/changelog_check.hh
+++ b/paludis/qa/changelog_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: is ChangeLog sane.
+ *
+ * \ingroup grpqacheck
+ */
class ChangeLogCheck :
public FileCheck
{
diff --git a/paludis/qa/check.hh b/paludis/qa/check.hh
index 82a9c47..3cea426 100644
--- a/paludis/qa/check.hh
+++ b/paludis/qa/check.hh
@@ -26,7 +26,7 @@
/** \file
* Declarations for the paludis::qa::Check class.
*
- * \ingroup QA
+ * \ingroup grpqa
*/
namespace paludis
@@ -36,7 +36,7 @@ namespace paludis
/**
* Base class for a QA check.
*
- * \ingroup QA
+ * \ingroup grpqa
*/
class PALUDIS_VISIBLE Check :
private InstantiationPolicy<Check, instantiation_method::NonCopyableTag>
diff --git a/paludis/qa/check_result.hh b/paludis/qa/check_result.hh
index c7f2717..d7834cd 100644
--- a/paludis/qa/check_result.hh
+++ b/paludis/qa/check_result.hh
@@ -27,7 +27,7 @@
/** \file
* Declarations for the CheckResult class.
*
- * \ingroup QA
+ * \ingroup grpqa
*/
namespace paludis
@@ -37,7 +37,7 @@ namespace paludis
/**
* The result of a QA check.
*
- * \ingroup QA
+ * \ingroup grpqa
*/
class PALUDIS_VISIBLE CheckResult
{
diff --git a/paludis/qa/create_metadata_check.hh b/paludis/qa/create_metadata_check.hh
index 1460582..109cfc8 100644
--- a/paludis/qa/create_metadata_check.hh
+++ b/paludis/qa/create_metadata_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: can metadata be generated.
+ *
+ * \ingroup grpqacheck
+ */
class CreateMetadataCheck :
public EbuildCheck
{
diff --git a/paludis/qa/defaults_check.hh b/paludis/qa/defaults_check.hh
index de1042e..8c6beaa 100644
--- a/paludis/qa/defaults_check.hh
+++ b/paludis/qa/defaults_check.hh
@@ -28,6 +28,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: default function reimplementations.
+ *
+ * \ingroup grpqacheck
+ */
class DefaultsCheck :
public FileCheck
{
diff --git a/paludis/qa/dep_any_check.hh b/paludis/qa/dep_any_check.hh
index e37df03..ed2968b 100644
--- a/paludis/qa/dep_any_check.hh
+++ b/paludis/qa/dep_any_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: || ( ) sanity.
+ *
+ * \ingroup grpqacheck
+ */
class DepAnyCheck :
public EbuildCheck
{
diff --git a/paludis/qa/dep_flags_check.hh b/paludis/qa/dep_flags_check.hh
index f8dbaaa..97f2dd0 100644
--- a/paludis/qa/dep_flags_check.hh
+++ b/paludis/qa/dep_flags_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA: check use? flags in metadata.
+ *
+ * \ingroup grpqacheck
+ */
class DepFlagsCheck :
public EbuildCheck
{
diff --git a/paludis/qa/dep_packages_check.hh b/paludis/qa/dep_packages_check.hh
index 577fda8..96782a4 100644
--- a/paludis/qa/dep_packages_check.hh
+++ b/paludis/qa/dep_packages_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: packages that should not usually be in *DEPEND.
+ *
+ * \ingroup grpqacheck
+ */
class DepPackagesCheck :
public EbuildCheck
{
diff --git a/paludis/qa/deprecated_functions_check.hh b/paludis/qa/deprecated_functions_check.hh
index 042faa9..e3dab8d 100644
--- a/paludis/qa/deprecated_functions_check.hh
+++ b/paludis/qa/deprecated_functions_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: calls to deprecated functions.
+ *
+ * \ingroup grpqacheck
+ */
class DeprecatedFunctionsCheck :
public FileCheck
{
diff --git a/paludis/qa/deps_exist_check.hh b/paludis/qa/deps_exist_check.hh
index a860c2f..43cb9df 100644
--- a/paludis/qa/deps_exist_check.hh
+++ b/paludis/qa/deps_exist_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: do packages in *DEPEND exist.
+ *
+ * \ingroup grpqacheck
+ */
class DepsExistCheck :
public EbuildCheck
{
diff --git a/paludis/qa/deps_visible_check.hh b/paludis/qa/deps_visible_check.hh
index f85f7f3..cf74edd 100644
--- a/paludis/qa/deps_visible_check.hh
+++ b/paludis/qa/deps_visible_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: deps visibility.
+ *
+ * \ingroup grpqa
+ */
class DepsVisibleCheck :
public EbuildCheck
{
diff --git a/paludis/qa/description_check.hh b/paludis/qa/description_check.hh
index 58a0700..c3c547c 100644
--- a/paludis/qa/description_check.hh
+++ b/paludis/qa/description_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: is DESCRIPTION ok.
+ *
+ * \ingroup grpqacheck
+ */
class DescriptionCheck :
public EbuildCheck
{
diff --git a/paludis/qa/digest_collisions_check.hh b/paludis/qa/digest_collisions_check.hh
index d8fe441..6024741 100644
--- a/paludis/qa/digest_collisions_check.hh
+++ b/paludis/qa/digest_collisions_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: digest collisions.
+ *
+ * \ingroup grpqacheck
+ */
class DigestCollisionsCheck :
public PackageDirCheck
{
diff --git a/paludis/qa/ebuild_check.hh b/paludis/qa/ebuild_check.hh
index 330d8a4..0de5d80 100644
--- a/paludis/qa/ebuild_check.hh
+++ b/paludis/qa/ebuild_check.hh
@@ -36,6 +36,11 @@ namespace paludis
#include <paludis/qa/ebuild_check-sr.hh>
+ /**
+ * Base class for QA checks that operate upon ebuilds.
+ *
+ * \ingroup grpqa
+ */
class PALUDIS_VISIBLE EbuildCheck :
public Check,
public InternalCounted<EbuildCheck>
@@ -47,6 +52,11 @@ namespace paludis
virtual CheckResult operator() (const EbuildCheckData &) const = 0;
};
+ /**
+ * Thrown if a bad package ebuild check is requested.
+ *
+ * \ingroup grpexceptions
+ */
class PALUDIS_VISIBLE NoSuchEbuildCheckTypeError :
public Exception
{
@@ -54,7 +64,13 @@ namespace paludis
NoSuchEbuildCheckTypeError(const std::string &) throw ();
};
- /* icc stupidity workaround */
+ /**
+ * Make an EbuildCheck class.
+ *
+ * We're implementing things this way to avoid breaking icc70. Icky.
+ *
+ * \ingroup grpqa
+ */
template <typename T_>
struct MakeEbuildCheck
{
diff --git a/paludis/qa/ebuild_count_check.hh b/paludis/qa/ebuild_count_check.hh
index 4a5fded..d2734c9 100644
--- a/paludis/qa/ebuild_count_check.hh
+++ b/paludis/qa/ebuild_count_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: is the ebuild count sane.
+ *
+ * \ingroup grpqacheck
+ */
class EbuildCountCheck :
public PackageDirCheck
{
diff --git a/paludis/qa/extract_check.hh b/paludis/qa/extract_check.hh
index 7248542..18a98af 100644
--- a/paludis/qa/extract_check.hh
+++ b/paludis/qa/extract_check.hh
@@ -26,6 +26,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: extraction dependencies.
+ *
+ * \ingroup grpqacheck
+ */
class ExtractCheck :
public EbuildCheck
{
diff --git a/paludis/qa/file_check.hh b/paludis/qa/file_check.hh
index fd07fca..048af41 100644
--- a/paludis/qa/file_check.hh
+++ b/paludis/qa/file_check.hh
@@ -30,7 +30,7 @@
/** \file
* Declarations for the FileCheck class.
*
- * \ingroup QA
+ * \ingroup grpqa
*/
namespace paludis
@@ -40,7 +40,7 @@ namespace paludis
/**
* A QA check that operates upon a file.
*
- * \ingroup QA
+ * \ingroup grpqa
*/
class PALUDIS_VISIBLE FileCheck :
public Check,
@@ -53,6 +53,11 @@ namespace paludis
virtual CheckResult operator() (const FSEntry &) const = 0;
};
+ /**
+ * Thrown if a bad file check is requested.
+ *
+ * \ingroup grpexceptions
+ */
class PALUDIS_VISIBLE NoSuchFileCheckTypeError :
public Exception
{
@@ -60,13 +65,24 @@ namespace paludis
NoSuchFileCheckTypeError(const std::string &) throw ();
};
- /* Do not turn this into a straight function. It makes icc cry. */
+ /**
+ * Make a FileCheck class.
+ *
+ * We're implementing things this way to avoid breaking icc70. Icky.
+ *
+ * \ingroup grpqa
+ */
template <typename T_>
struct MakeFileCheck
{
static FileCheck::Pointer make_file_check();
};
+ /**
+ * Virtual constructor for file checks.
+ *
+ * \ingroup grpqa
+ */
typedef VirtualConstructor<
std::string,
FileCheck::Pointer (*) (),
diff --git a/paludis/qa/file_permissions_check.hh b/paludis/qa/file_permissions_check.hh
index d6d6f8c..b466cc0 100644
--- a/paludis/qa/file_permissions_check.hh
+++ b/paludis/qa/file_permissions_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: file permissions.
+ *
+ * \ingroup grpqacheck
+ */
class FilePermissionsCheck :
public FileCheck
{
diff --git a/paludis/qa/filename_check.hh b/paludis/qa/filename_check.hh
index 3b4b7b0..722fc6d 100644
--- a/paludis/qa/filename_check.hh
+++ b/paludis/qa/filename_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: filename sanity.
+ *
+ * \ingroup grpqacheck
+ */
class FileNameCheck :
public FileCheck
{
diff --git a/paludis/qa/files_dir_size_check.hh b/paludis/qa/files_dir_size_check.hh
index 29af68f..8e9d585 100644
--- a/paludis/qa/files_dir_size_check.hh
+++ b/paludis/qa/files_dir_size_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: is files/ too big.
+ *
+ * \ingroup grpqacheck
+ */
class FilesDirSizeCheck :
public PackageDirCheck
{
diff --git a/paludis/qa/glep_31_check.hh b/paludis/qa/glep_31_check.hh
index 094334c..b88bcb4 100644
--- a/paludis/qa/glep_31_check.hh
+++ b/paludis/qa/glep_31_check.hh
@@ -28,6 +28,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: GLEP 31 compliance.
+ *
+ * \ingroup grpqacheck
+ */
class Glep31Check :
public FileCheck
{
diff --git a/paludis/qa/gpg_check.hh b/paludis/qa/gpg_check.hh
index 7ada6eb..b7e07fb 100644
--- a/paludis/qa/gpg_check.hh
+++ b/paludis/qa/gpg_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: is Manifest gpg signed?
+ *
+ * \ingroup grpqacheck
+ */
class GPGCheck :
public PackageDirCheck
{
diff --git a/paludis/qa/has_ebuilds_check.hh b/paludis/qa/has_ebuilds_check.hh
index 56bb744..baf2dc3 100644
--- a/paludis/qa/has_ebuilds_check.hh
+++ b/paludis/qa/has_ebuilds_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: ebuild prescence.
+ *
+ * \ingroup grpqacheck
+ */
class HasEbuildsCheck :
public PackageDirCheck
{
diff --git a/paludis/qa/has_misc_files_check.hh b/paludis/qa/has_misc_files_check.hh
index d82b302..3af0006 100644
--- a/paludis/qa/has_misc_files_check.hh
+++ b/paludis/qa/has_misc_files_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: check that misc files exist.
+ *
+ * \ingroup grpqacheck
+ */
class HasMiscFilesCheck :
public PackageDirCheck
{
diff --git a/paludis/qa/homepage_check.hh b/paludis/qa/homepage_check.hh
index ae67371..cc40fbc 100644
--- a/paludis/qa/homepage_check.hh
+++ b/paludis/qa/homepage_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: HOMEPAGE sanity.
+ *
+ * \ingroup grpqacheck
+ */
class HomepageCheck :
public EbuildCheck
{
diff --git a/paludis/qa/inherits_check.hh b/paludis/qa/inherits_check.hh
index 00f1468..47ab06f 100644
--- a/paludis/qa/inherits_check.hh
+++ b/paludis/qa/inherits_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: inherits sanity.
+ *
+ * \ingroup grpqacheck
+ */
class InheritsCheck :
public EbuildCheck
{
diff --git a/paludis/qa/iuse_check.hh b/paludis/qa/iuse_check.hh
index 92b0995..37346ed 100644
--- a/paludis/qa/iuse_check.hh
+++ b/paludis/qa/iuse_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: IUSE.
+ *
+ * \ingroup grpqacheck
+ */
class IuseCheck :
public EbuildCheck
{
diff --git a/paludis/qa/keywords_check.hh b/paludis/qa/keywords_check.hh
index d04eab0..b284fb2 100644
--- a/paludis/qa/keywords_check.hh
+++ b/paludis/qa/keywords_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: keywords.
+ *
+ * \ingroup grpqacheck
+ */
class KeywordsCheck :
public EbuildCheck
{
diff --git a/paludis/qa/license_check.hh b/paludis/qa/license_check.hh
index 49b6b76..94cf3cf 100644
--- a/paludis/qa/license_check.hh
+++ b/paludis/qa/license_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: LICENSE sanity.
+ *
+ * \ingroup grpqacheck
+ */
class LicenseCheck :
public EbuildCheck
{
diff --git a/paludis/qa/message.hh b/paludis/qa/message.hh
index e3bf632..4607491 100644
--- a/paludis/qa/message.hh
+++ b/paludis/qa/message.hh
@@ -26,13 +26,18 @@
/** \file
* Declarations for the Message class.
*
- * \ingroup QA
+ * \ingroup grpqa
*/
namespace paludis
{
namespace qa
{
+ /**
+ * Severity level of a QA message.
+ *
+ * \ingroup grpqa
+ */
enum QALevel
{
qal_info,
@@ -45,6 +50,11 @@ namespace paludis
#include <paludis/qa/message-sr.hh>
+ /**
+ * Write a QA message to a stream.
+ *
+ * \ingroup grpqa
+ */
std::ostream & operator<< (std::ostream &, const Message &);
}
}
diff --git a/paludis/qa/metadata_check.hh b/paludis/qa/metadata_check.hh
index fc61b79..ab3dbc9 100644
--- a/paludis/qa/metadata_check.hh
+++ b/paludis/qa/metadata_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: metadata.xml.
+ *
+ * \ingroup grpqacheck
+ */
class MetadataCheck :
public FileCheck
{
diff --git a/paludis/qa/metadata_file.hh b/paludis/qa/metadata_file.hh
index 4eed78f..457a770 100644
--- a/paludis/qa/metadata_file.hh
+++ b/paludis/qa/metadata_file.hh
@@ -29,6 +29,11 @@ namespace paludis
namespace qa
{
+ /**
+ * Wrapper around metadata.xml files.
+ *
+ * \ingroup grpqa
+ */
class MetadataFile :
public PrivateImplementationPattern<MetadataFile>
{
diff --git a/paludis/qa/package_dir_check.hh b/paludis/qa/package_dir_check.hh
index 0a5aa89..fa40c74 100644
--- a/paludis/qa/package_dir_check.hh
+++ b/paludis/qa/package_dir_check.hh
@@ -30,7 +30,7 @@
/** \file
* Declarations for the PackageDirCheck class.
*
- * \ingroup QA
+ * \ingroup grpqa
*/
namespace paludis
@@ -40,7 +40,7 @@ namespace paludis
/**
* A QA check that operates upon a package directory.
*
- * \ingroup QA
+ * \ingroup grpqa
*/
class PackageDirCheck :
public Check,
@@ -53,6 +53,11 @@ namespace paludis
virtual CheckResult operator() (const FSEntry &) const = 0;
};
+ /**
+ * Thrown if a bad package dir check is requested.
+ *
+ * \ingroup grpexceptions
+ */
class NoSuchPackageDirCheckTypeError :
public Exception
{
@@ -60,7 +65,13 @@ namespace paludis
NoSuchPackageDirCheckTypeError(const std::string &) throw ();
};
- /* icc is dumb */
+ /**
+ * Make a PackageDirCheck class.
+ *
+ * We're implementing things this way to avoid breaking icc70. Icky.
+ *
+ * \ingroup grpqa
+ */
template <typename T_>
struct MakePackageDirCheck
{
@@ -71,6 +82,11 @@ namespace paludis
}
};
+ /**
+ * Virtual constructor for package dir checks.
+ *
+ * \ingroup grpqa
+ */
typedef VirtualConstructor<
std::string,
PackageDirCheck::Pointer (*) (),
diff --git a/paludis/qa/package_name_check.hh b/paludis/qa/package_name_check.hh
index e19a4a4..b661f76 100644
--- a/paludis/qa/package_name_check.hh
+++ b/paludis/qa/package_name_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: category/packge name sanity.
+ *
+ * \ingroup grpqacheck
+ */
class PackageNameCheck :
public PackageDirCheck
{
diff --git a/paludis/qa/parse_deps_check.hh b/paludis/qa/parse_deps_check.hh
index 384620a..82c43a4 100644
--- a/paludis/qa/parse_deps_check.hh
+++ b/paludis/qa/parse_deps_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: are deps parsable?
+ *
+ * \ingroup grpqacheck
+ */
class ParseDepsCheck :
public EbuildCheck
{
diff --git a/paludis/qa/pdepend_overlap_check.hh b/paludis/qa/pdepend_overlap_check.hh
index 440f885..33b5eb1 100644
--- a/paludis/qa/pdepend_overlap_check.hh
+++ b/paludis/qa/pdepend_overlap_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: PDEPEND overlaps.
+ *
+ * \ingroup grpqacheck
+ */
class PdependOverlapCheck :
public EbuildCheck
{
diff --git a/paludis/qa/qa_environment.hh b/paludis/qa/qa_environment.hh
index 90d8a53..44e43ca 100644
--- a/paludis/qa/qa_environment.hh
+++ b/paludis/qa/qa_environment.hh
@@ -64,6 +64,11 @@ namespace paludis
virtual std::string paludis_command() const;
};
+ /**
+ * Thrown if a profiles.desc file is broken.
+ *
+ * \ingroup grpexceptions
+ */
class ProfilesDescError :
public ConfigurationError
{
diff --git a/paludis/qa/restrict_check.hh b/paludis/qa/restrict_check.hh
index 6916c1c..c3706ce 100644
--- a/paludis/qa/restrict_check.hh
+++ b/paludis/qa/restrict_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: is RESTRICT sane.
+ *
+ * \ingroup grpqacheck
+ */
class RestrictCheck :
public EbuildCheck
{
diff --git a/paludis/qa/slot_check.hh b/paludis/qa/slot_check.hh
index b8cd486..1b5f568 100644
--- a/paludis/qa/slot_check.hh
+++ b/paludis/qa/slot_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: is SLOT sane.
+ *
+ * \ingroup grpqacheck
+ */
class SlotCheck :
public EbuildCheck
{
diff --git a/paludis/qa/src_uri_check.hh b/paludis/qa/src_uri_check.hh
index fa3aba5..250e1e3 100644
--- a/paludis/qa/src_uri_check.hh
+++ b/paludis/qa/src_uri_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: is SRC_URI good.
+ *
+ * \ingroup grpqacheck
+ */
class SrcUriCheck :
public EbuildCheck
{
diff --git a/paludis/qa/whitespace_check.hh b/paludis/qa/whitespace_check.hh
index 6a8a3ec..4d237a5 100644
--- a/paludis/qa/whitespace_check.hh
+++ b/paludis/qa/whitespace_check.hh
@@ -27,6 +27,11 @@ namespace paludis
{
namespace qa
{
+ /**
+ * QA check: whitespace.
+ *
+ * \ingroup grpqacheck
+ */
class WhitespaceCheck :
public FileCheck
{
diff --git a/paludis/repositories/cran/cran_dep_parser_TEST.cc b/paludis/repositories/cran/cran_dep_parser_TEST.cc
index 9308c8d..524db31 100644
--- a/paludis/repositories/cran/cran_dep_parser_TEST.cc
+++ b/paludis/repositories/cran/cran_dep_parser_TEST.cc
@@ -114,7 +114,6 @@ namespace
/** \file
* Test cases for CRANRepository.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -122,7 +121,6 @@ namespace test_cases
/**
* \test Test CRANDepParser::parse to parse well formed CRAN Depends: strings.
*
- * \ingroup grptestcases
*/
struct CRANDepParserTest : TestCase
{
diff --git a/paludis/repositories/fake/fake_installed_repository.hh b/paludis/repositories/fake/fake_installed_repository.hh
index 899a916..a7a1399 100644
--- a/paludis/repositories/fake/fake_installed_repository.hh
+++ b/paludis/repositories/fake/fake_installed_repository.hh
@@ -24,6 +24,11 @@
namespace paludis
{
+ /**
+ * A fake repository for test cases, for installed packages.
+ *
+ * \ingroup grpfakerepository
+ */
class PALUDIS_VISIBLE FakeInstalledRepository :
public FakeRepositoryBase,
public RepositoryInstalledInterface
diff --git a/paludis/repositories/fake/fake_repository.hh b/paludis/repositories/fake/fake_repository.hh
index a39c42f..fd632d8 100644
--- a/paludis/repositories/fake/fake_repository.hh
+++ b/paludis/repositories/fake/fake_repository.hh
@@ -24,6 +24,11 @@
namespace paludis
{
+ /**
+ * Fake repository for use in test cases.
+ *
+ * \ingroup grpfakerepository
+ */
class PALUDIS_VISIBLE FakeRepository :
public FakeRepositoryBase,
public RepositoryInstallableInterface
diff --git a/paludis/repositories/portage/glsa.hh b/paludis/repositories/portage/glsa.hh
index dc25d8f..e39cfbc 100644
--- a/paludis/repositories/portage/glsa.hh
+++ b/paludis/repositories/portage/glsa.hh
@@ -34,6 +34,11 @@ namespace paludis
#include <paludis/repositories/portage/glsa-sr.hh>
+ /**
+ * Thrown if a bad GLSA is found.
+ *
+ * \ingroup grpexceptions
+ */
class PALUDIS_VISIBLE GLSAError :
public ConfigurationError
{
@@ -47,6 +52,12 @@ namespace paludis
///\}
};
+ /**
+ * Represents a package entry in a GLSA.
+ *
+ * \see GLSA
+ * \ingroup grpportagerepository
+ */
class PALUDIS_VISIBLE GLSAPackage :
private PrivateImplementationPattern<GLSAPackage>,
public InternalCounted<GLSAPackage>
@@ -71,6 +82,11 @@ namespace paludis
QualifiedPackageName name() const;
};
+ /**
+ * Represents a GLSA (security advisory).
+ *
+ * \ingroup grpportagerepository
+ */
class PALUDIS_VISIBLE GLSA :
private PrivateImplementationPattern<GLSA>,
public InternalCounted<GLSA>
diff --git a/paludis/repositories/portage/portage_repository_TEST.cc b/paludis/repositories/portage/portage_repository_TEST.cc
index 1310d6e..80ac322 100644
--- a/paludis/repositories/portage/portage_repository_TEST.cc
+++ b/paludis/repositories/portage/portage_repository_TEST.cc
@@ -31,7 +31,6 @@ using namespace paludis;
/** \file
* Test cases for PortageRepository.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -39,7 +38,6 @@ namespace test_cases
/**
* \test Test PortageRepository repository names.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryRepoNameTest : TestCase
{
@@ -62,7 +60,6 @@ namespace test_cases
/**
* \test Test PortageRepository repository with no names.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryNoRepoNameTest : TestCase
{
@@ -85,7 +82,6 @@ namespace test_cases
/**
* \test Test PortageRepository repository empty names.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryEmptyRepoNameTest : TestCase
{
@@ -108,7 +104,6 @@ namespace test_cases
/**
* \test Test PortageRepository repository has_category_named.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryHasCategoryNamedTest : TestCase
{
@@ -140,7 +135,6 @@ namespace test_cases
/**
* \test Test PortageRepository category_names.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryCategoryNamesTest : TestCase
{
@@ -174,7 +168,6 @@ namespace test_cases
/**
* \test Test PortageRepository has_package_named.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryHasPackageNamedTest : TestCase
{
@@ -214,7 +207,6 @@ namespace test_cases
/**
* \test Test PortageRepository has_package_named cached.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryHasPackageNamedCachedTest : TestCase
{
@@ -258,7 +250,6 @@ namespace test_cases
/**
* \test Test PortageRepository package_names.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryPackageNamesTest : TestCase
{
@@ -311,7 +302,6 @@ namespace test_cases
/**
* \test Test PortageRepository bad package names.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryBadPackageNamesTest : TestCase
{
@@ -345,7 +335,6 @@ namespace test_cases
/**
* \test Test PortageRepository has_version.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryHasVersionTest : TestCase
{
@@ -389,7 +378,6 @@ namespace test_cases
/**
* \test Test PortageRepository versions.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryVersionsTest : TestCase
{
@@ -432,7 +420,6 @@ namespace test_cases
/**
* \test Test PortageRepository duff versions.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryDuffVersionsTest : TestCase
{
@@ -475,7 +462,6 @@ namespace test_cases
/**
* \test Test PortageRepository cached metadata.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryMetadataCachedTest : TestCase
{
@@ -511,7 +497,6 @@ namespace test_cases
/**
* \test Test PortageRepository uncached metadata.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryMetadataUncachedTest : TestCase
{
@@ -548,7 +533,6 @@ namespace test_cases
/**
* \test Test PortageRepository unparsable metadata.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryMetadataUnparsableTest : TestCase
{
@@ -584,7 +568,6 @@ namespace test_cases
/**
* \test Test PortageRepository query_use and query_use_mask functions.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryQueryUseTest : TestCase
{
@@ -632,7 +615,6 @@ namespace test_cases
/**
* \test Test PortageRepository query_profile_masks functions.
*
- * \ingroup grptestcases
*/
struct PortageRepositoryQueryProfileMasksTest : TestCase
{
diff --git a/paludis/repositories/portage/portage_repository_profile_file.hh b/paludis/repositories/portage/portage_repository_profile_file.hh
index 2cda5ed..baa6552 100644
--- a/paludis/repositories/portage/portage_repository_profile_file.hh
+++ b/paludis/repositories/portage/portage_repository_profile_file.hh
@@ -27,6 +27,13 @@
namespace paludis
{
+ /**
+ * A file in a PortageRepository profile.
+ *
+ * Handles -lines, comments, inherits automatically.
+ *
+ * \ingroup grpportagerepository
+ */
class PALUDIS_VISIBLE ProfileFile :
private PrivateImplementationPattern<ProfileFile>
{
diff --git a/paludis/repositories/vdb/vdb_repository_TEST.cc b/paludis/repositories/vdb/vdb_repository_TEST.cc
index 15a8f46..450b118 100644
--- a/paludis/repositories/vdb/vdb_repository_TEST.cc
+++ b/paludis/repositories/vdb/vdb_repository_TEST.cc
@@ -31,7 +31,6 @@ using namespace paludis;
/** \file
* Test cases for VDBRepository.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -39,7 +38,6 @@ namespace test_cases
/**
* \test Test VDBRepository repo names
*
- * \ingroup grptestcases
*/
struct VDBRepositoryRepoNameTest : TestCase
{
@@ -61,7 +59,6 @@ namespace test_cases
/**
* \test Test VDBRepository has_category_named
*
- * \ingroup grptestcases
*/
struct VDBRepositoryHasCategoryNamedTest : TestCase
{
@@ -86,7 +83,6 @@ namespace test_cases
/**
* \test Test VDBRepository query_use
*
- * \ingroup grptestcases
*/
struct VDBRepositoryQueryUseTest : TestCase
{
diff --git a/paludis/repositories/virtuals/installed_virtuals_repository.hh b/paludis/repositories/virtuals/installed_virtuals_repository.hh
index c145ecc..108906d 100644
--- a/paludis/repositories/virtuals/installed_virtuals_repository.hh
+++ b/paludis/repositories/virtuals/installed_virtuals_repository.hh
@@ -24,6 +24,11 @@
namespace paludis
{
+ /**
+ * Repository representing installed virtual packages.
+ *
+ * \ingroup grpvirtualsrepository
+ */
class PALUDIS_VISIBLE InstalledVirtualsRepository :
public Repository,
public RepositoryInstalledInterface,
diff --git a/paludis/repositories/virtuals/virtuals_repository.hh b/paludis/repositories/virtuals/virtuals_repository.hh
index 10cb520..108ae80 100644
--- a/paludis/repositories/virtuals/virtuals_repository.hh
+++ b/paludis/repositories/virtuals/virtuals_repository.hh
@@ -24,6 +24,11 @@
namespace paludis
{
+ /**
+ * A repository holding packages representing virtuals.
+ *
+ * \ingroup grpvirtualsrepository
+ */
class PALUDIS_VISIBLE VirtualsRepository :
public Repository,
public RepositoryInstallableInterface,
diff --git a/paludis/tasks/install_task.hh b/paludis/tasks/install_task.hh
index 34a4cd3..99af587 100644
--- a/paludis/tasks/install_task.hh
+++ b/paludis/tasks/install_task.hh
@@ -28,6 +28,11 @@ namespace paludis
{
class Environment;
+ /**
+ * Thrown if multiple set targets are specified.
+ *
+ * \ingroup grpexceptions
+ */
class PALUDIS_VISIBLE MultipleSetTargetsSpecified :
public Exception
{
@@ -35,6 +40,11 @@ namespace paludis
MultipleSetTargetsSpecified() throw ();
};
+ /**
+ * Thrown if both sets and packages are specified as targets.
+ *
+ * \ingroup grpexceptions
+ */
class PALUDIS_VISIBLE HadBothPackageAndSetTargets :
public Exception
{
@@ -42,6 +52,11 @@ namespace paludis
HadBothPackageAndSetTargets() throw ();
};
+ /**
+ * Task used to install one or more targets.
+ *
+ * \ingroup grptasks
+ */
class PALUDIS_VISIBLE InstallTask :
PrivateImplementationPattern<InstallTask>,
InstantiationPolicy<InstallTask, instantiation_method::NonCopyableTag>
diff --git a/paludis/tasks/sync_task.hh b/paludis/tasks/sync_task.hh
index baedfd7..989f66a 100644
--- a/paludis/tasks/sync_task.hh
+++ b/paludis/tasks/sync_task.hh
@@ -29,6 +29,11 @@ namespace paludis
class Environment;
class SyncFailedError;
+ /**
+ * Task to handle syncing some or all repositories.
+ *
+ * \ingroup grptasks
+ */
class PALUDIS_VISIBLE SyncTask :
PrivateImplementationPattern<SyncTask>,
InstantiationPolicy<SyncTask, instantiation_method::NonCopyableTag>
diff --git a/paludis/tasks/uninstall_task.hh b/paludis/tasks/uninstall_task.hh
index 5820bca..707b1af 100644
--- a/paludis/tasks/uninstall_task.hh
+++ b/paludis/tasks/uninstall_task.hh
@@ -29,6 +29,11 @@ namespace paludis
{
class Environment;
+ /**
+ * Thrown if an ambiguous unmerge target is supplied.
+ *
+ * \ingroup grpexceptions
+ */
class PALUDIS_VISIBLE AmbiguousUnmergeTargetError :
public Exception
{
@@ -65,6 +70,11 @@ namespace paludis
}
};
+ /**
+ * Task used to uninstall one or more targets.
+ *
+ * \ingroup grptasks
+ */
class PALUDIS_VISIBLE UninstallTask :
PrivateImplementationPattern<UninstallTask>,
InstantiationPolicy<UninstallTask, instantiation_method::NonCopyableTag>
diff --git a/paludis/test_extras.cc b/paludis/test_extras.cc
index ec9e6a3..b1b3f77 100644
--- a/paludis/test_extras.cc
+++ b/paludis/test_extras.cc
@@ -28,7 +28,6 @@
/** \file
* Extra settings for test cases.
*
- * \ingroup grptestcases
*/
using namespace paludis;
@@ -38,7 +37,6 @@ namespace
/**
* Convert an exception to a debug string.
*
- * \ingroup grptestcases
*/
std::string verbose_exception_to_debug_string(
const std::exception & e) PALUDIS_ATTRIBUTE((noinline));
@@ -46,7 +44,6 @@ namespace
/**
* Avoid logging visibly.
*
- * \ingroup grptestcases
*/
struct C
{
@@ -64,7 +61,6 @@ namespace
/**
* Avoid logging visibly.
*
- * \ingroup grptestcases
*/
static const C my_c;
diff --git a/paludis/util/attributes.hh.in b/paludis/util/attributes.hh.in
index f5f83b5..468cb79 100644
--- a/paludis/util/attributes.hh.in
+++ b/paludis/util/attributes.hh.in
@@ -1,5 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
+@GENERATED_FILE@
+
/*
* Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
*
@@ -40,6 +42,24 @@
* \ingroup grplibpaludisutil
*/
+/** \def PALUDIS_ENABLE_VISIBILITY
+ * Whether to enable visibility support.
+ *
+ * \ingroup grplibpaludisutil
+ */
+
+/** \def PALUDIS_VISIBLE
+ * Marker used to represent 'make visible', if visibility is enabled.
+ *
+ * \ingroup grplibpaludisutil
+ */
+
+/** \def PALUDIS_HIDDEN
+ * Marker used to represent 'make hidden', if visibility is enabled.
+ *
+ * \ingroup grplibpaludisutil
+ */
+
#if (defined(__GNUC__) || defined(DOXYGEN))
# if ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4) || defined(DOXYGEN))
# define PALUDIS_ATTRIBUTE(x) __attribute__(x)
diff --git a/paludis/util/counted_ptr_TEST.cc b/paludis/util/counted_ptr_TEST.cc
index 5faaab7..efe0f82 100644
--- a/paludis/util/counted_ptr_TEST.cc
+++ b/paludis/util/counted_ptr_TEST.cc
@@ -28,7 +28,6 @@ using namespace paludis;
/** \file
* Test cases for counted_ptr.hh .
*
- * \ingroup grptestcases
*/
namespace
@@ -36,7 +35,6 @@ namespace
/**
* Test InternalCounted class.
*
- * \ingroup grptestcases
*/
class MyClass :
public InternalCounted<MyClass>
@@ -77,7 +75,6 @@ namespace
/**
* Test InternalCounted class is stringifiable.
*
- * \ingroup grptestcases
*/
std::ostream & operator<< (std::ostream & s, const MyClass & c)
{
@@ -90,7 +87,6 @@ namespace test_cases
/**
* \test CountedPtr creation tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrCreationTests : TestCase
{
@@ -106,7 +102,6 @@ namespace test_cases
/**
* \test CountedPtr dereference tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrDereferenceTests : TestCase
{
@@ -126,7 +121,6 @@ namespace test_cases
/**
* \test CountedPtr copy tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrCopyTests : TestCase
{
@@ -146,7 +140,6 @@ namespace test_cases
/**
* \test CountedPtr dereference-assign tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrDereferenceAssignTests : TestCase
{
@@ -176,7 +169,6 @@ namespace test_cases
/**
* \test CountedPtr assign value tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrAssignValueTests : TestCase
{
@@ -199,7 +191,6 @@ namespace test_cases
/**
* \test CountedPtr assign pointer tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrAssignPointerTests : TestCase
{
@@ -231,7 +222,6 @@ namespace test_cases
/**
* \test CountedPtr internal creation tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrInternalCreationTests : TestCase
{
@@ -246,7 +236,6 @@ namespace test_cases
/**
* \test CountedPtr internal dereference tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrInternalDereferenceTests : TestCase
{
@@ -265,7 +254,6 @@ namespace test_cases
/**
* \test CountedPtr internal copy tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrInternalCopyTests : TestCase
{
@@ -285,7 +273,6 @@ namespace test_cases
/**
* \test CountedPtr internal dereference-assign tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrInternalDereferenceAssignTests : TestCase
{
@@ -316,7 +303,6 @@ namespace test_cases
/**
* \test CountedPtr internal assign value tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrInternalAssignValueTests : TestCase
{
@@ -340,7 +326,6 @@ namespace test_cases
/**
* \test CountedPtr internal assign pointer tests.
*
- * \ingroup grptestcases
*/
struct CountedPtrInternalAssignPointerTests : TestCase
{
diff --git a/paludis/util/destringify_TEST.cc b/paludis/util/destringify_TEST.cc
index 8ea4cd6..6c49454 100644
--- a/paludis/util/destringify_TEST.cc
+++ b/paludis/util/destringify_TEST.cc
@@ -28,7 +28,6 @@ using namespace paludis;
/** \file
* Test cases for destringify.hh
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -36,7 +35,6 @@ namespace test_cases
/** \test
* Test destringify for integers.
*
- * \ingroup grptestcases
*/
struct DestringifyIntTests : TestCase
{
@@ -56,7 +54,6 @@ namespace test_cases
/** \test
* Test destringify for floats.
*
- * \ingroup grptestcases
*/
struct DestringifyFloatTests : TestCase
{
@@ -75,7 +72,6 @@ namespace test_cases
/** \test
* Test destringify for strings.
*
- * \ingroup grptestcases
*/
struct DestringifyStringTests : TestCase
{
@@ -91,7 +87,6 @@ namespace test_cases
/** \test
* Test destringify for bool.
*
- * \ingroup grptestcases
*/
struct DestringifyBoolTests : TestCase
{
diff --git a/paludis/util/instantiation_policy_TEST.cc b/paludis/util/instantiation_policy_TEST.cc
index 6c8aa34..550602e 100644
--- a/paludis/util/instantiation_policy_TEST.cc
+++ b/paludis/util/instantiation_policy_TEST.cc
@@ -28,7 +28,6 @@ using namespace paludis;
/** \file
* Test cases for instantiation_policy.hh .
*
- * \ingroup grptestcases
*/
namespace
@@ -36,7 +35,6 @@ namespace
/**
* Test class for InstantiationPolicy.
*
- * \ingroup grptestcases
*/
class MyClass :
public InstantiationPolicy<MyClass, instantiation_method::SingletonAsNeededTag>
@@ -106,7 +104,6 @@ namespace test_cases
/**
* \test Test singleton behaviour.
*
- * \ingroup grptestcases
*/
struct SingletonPatternTest : TestCase
{
@@ -132,7 +129,6 @@ namespace test_cases
/**
* \test Test singleton behaviour.
*
- * \ingroup grptestcases
*/
struct SingletonPatternDeleteTest : TestCase
{
@@ -163,7 +159,6 @@ namespace test_cases
/**
* \test Test singleton create at startup behaviour.
*
- * \ingroup grptestcases
*/
struct SingletonPatternCreateAtStartupTest : TestCase
{
diff --git a/paludis/util/is_file_with_extension_TEST.cc b/paludis/util/is_file_with_extension_TEST.cc
index a60c224..43f96b5 100644
--- a/paludis/util/is_file_with_extension_TEST.cc
+++ b/paludis/util/is_file_with_extension_TEST.cc
@@ -26,7 +26,6 @@
/** \file
* Test cases for IsFileWithExtension.
*
- * \ingroup grptestcases
*/
using namespace paludis;
@@ -37,7 +36,6 @@ namespace test_cases
/**
* \test Test IsFileWithExtension.
*
- * \ingroup grptestcases
*/
struct IsFileWithExtensionTest : TestCase
{
@@ -64,7 +62,6 @@ namespace test_cases
/**
* \test Test IsFileWithExtension with a prefix.
*
- * \ingroup grptestcases
*/
struct IsFileWithExtensionPrefixTest : TestCase
{
diff --git a/paludis/util/iterator_TEST.cc b/paludis/util/iterator_TEST.cc
index 83055d0..9f5a30e 100644
--- a/paludis/util/iterator_TEST.cc
+++ b/paludis/util/iterator_TEST.cc
@@ -32,7 +32,6 @@ using namespace paludis;
/** \file
* Test cases for iterator utilities.
*
- * \ingroup grptestcases
*/
namespace
@@ -63,7 +62,6 @@ namespace test_cases
/**
* \test Test IndirectIterator over a vector of CountedPtr of int.
*
- * \ingroup grptestcases
*/
struct IndirectIteratorVecCPIntTest : TestCase
{
@@ -91,7 +89,6 @@ namespace test_cases
/**
* \test Test IndirectIterator over a list of CountedPtr of int.
*
- * \ingroup grptestcases
*/
struct IndirectIteratorListCPIntTest : TestCase
{
@@ -115,7 +112,6 @@ namespace test_cases
/**
* \test Test IndirectIterator over a vector of int *.
*
- * \ingroup grptestcases
*/
struct IndirectIteratorVecPIntTest : TestCase
{
@@ -144,7 +140,6 @@ namespace test_cases
/**
* \test Test IndirectIterator over a list of int *.
*
- * \ingroup grptestcases
*/
struct IndirectIteratorListPIntTest : TestCase
{
@@ -195,7 +190,6 @@ namespace test_cases
/**
* \test Test FilterInsertIterator.
*
- * \ingroup grptestcases
*/
struct FilterInsertIteratorTest : TestCase
{
@@ -224,7 +218,6 @@ namespace test_cases
/**
* \test Test iterator_utilities next()
*
- * \ingroup grptestcases
*/
struct IteratorNextTest : public TestCase
{
@@ -247,7 +240,6 @@ namespace test_cases
/**
* \test Test iterator_utilities previous()
*
- * \ingroup grptestcases
*/
struct IteratorpreviousTest : public TestCase
{
@@ -280,7 +272,6 @@ namespace test_cases
/**
* \test Test TransformInsertIterator.
*
- * \ingroup grptestcases
*/
struct TransformInsertIteratorTest : TestCase
{
@@ -303,7 +294,6 @@ namespace test_cases
/**
* \test Test SelectFirst and SelectSecond.
*
- * \ingroup grptestcases
*/
struct SimpleSelectPairTest : TestCase
{
@@ -338,7 +328,6 @@ namespace test_cases
/**
* \test Test create_inserter.
*
- * \ingroup grptestcases
*/
struct CreateInsertIteratorTest : TestCase
{
diff --git a/paludis/util/join_TEST.cc b/paludis/util/join_TEST.cc
index 352c5ca..42eca4c 100644
--- a/paludis/util/join_TEST.cc
+++ b/paludis/util/join_TEST.cc
@@ -29,7 +29,6 @@ using namespace test;
/** \file
* Test cases for join.hh .
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -37,7 +36,6 @@ namespace test_cases
/**
* \test Test join on a vector.
*
- * \ingroup grptestcases
*/
struct JoinVectorTest : TestCase
{
@@ -58,7 +56,6 @@ namespace test_cases
/**
* \test Test join on a list.
*
- * \ingroup grptestcases
*/
struct JoinListTest : TestCase
{
@@ -79,7 +76,6 @@ namespace test_cases
/**
* \test Test join with empty things.
*
- * \ingroup grptestcases
*/
struct JoinEmptyTest : TestCase
{
diff --git a/paludis/util/log.hh b/paludis/util/log.hh
index a101105..ff7576d 100644
--- a/paludis/util/log.hh
+++ b/paludis/util/log.hh
@@ -112,6 +112,11 @@ namespace paludis
void set_program_name(const std::string &);
};
+ /**
+ * Stringify a LogLevel constant.
+ *
+ * \ingroup grplog
+ */
std::ostream &
operator<< (std::ostream &, const LogLevel &) PALUDIS_VISIBLE;
}
diff --git a/paludis/util/pstream_TEST.cc b/paludis/util/pstream_TEST.cc
index 2f943cc..517d3eb 100644
--- a/paludis/util/pstream_TEST.cc
+++ b/paludis/util/pstream_TEST.cc
@@ -27,7 +27,6 @@ using namespace test;
/** \file
* Tests for PStream.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -35,7 +34,6 @@ namespace test_cases
/**
* \test Test PStream on a normal command.
*
- * \ingroup grptestcases
*/
struct PStreamTest : TestCase
{
@@ -57,7 +55,6 @@ namespace test_cases
/**
* \test Test PStream on a command that doesn't exist.
*
- * \ingroup grptestcases
*/
struct PStreamNoExistTest : TestCase
{
@@ -73,7 +70,6 @@ namespace test_cases
/**
* \test Test PStream on a command that returns a failure with no output.
*
- * \ingroup grptestcases
*/
struct PStreamSilentFailTest : TestCase
{
@@ -89,7 +85,6 @@ namespace test_cases
/**
* \test Test PStream on a command that fails with output.
*
- * \ingroup grptestcases
*/
struct PStreamFailTest : TestCase
{
diff --git a/paludis/util/random_TEST.cc b/paludis/util/random_TEST.cc
index 8188cbb..3e6fa5f 100644
--- a/paludis/util/random_TEST.cc
+++ b/paludis/util/random_TEST.cc
@@ -26,7 +26,6 @@
/** \file
* Test cases for paludis::Random.
*
- * \ingroup grptestcases
*/
using namespace paludis;
@@ -62,7 +61,6 @@ namespace test_cases
/**
* \test Test Random distibutions using counts.
*
- * \ingroup grptestcases
*/
struct RandomDistributionCountsTest : TestCase
{
diff --git a/paludis/util/save_TEST.cc b/paludis/util/save_TEST.cc
index 362b671..3376981 100644
--- a/paludis/util/save_TEST.cc
+++ b/paludis/util/save_TEST.cc
@@ -27,7 +27,6 @@ using namespace paludis;
/** \file
* Test cases for save.hh .
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -35,7 +34,6 @@ namespace test_cases
/**
* \test Test Save.
*
- * \ingroup grptestcases
*/
struct SaveTest : TestCase
{
diff --git a/paludis/util/sr.hh b/paludis/util/sr.hh
index 7f41fb6..c364f07 100644
--- a/paludis/util/sr.hh
+++ b/paludis/util/sr.hh
@@ -22,6 +22,11 @@
namespace paludis
{
+ /**
+ * Metaprogramming: an empty class.
+ *
+ * \ingroup grpsr
+ */
struct Empty
{
};
@@ -29,12 +34,22 @@ namespace paludis
template <bool value_, typename IfTrue_, typename IfFalse_>
struct Select;
+ /**
+ * Metaprogramming: select a type based upon a condition.
+ *
+ * \ingroup grpsr
+ */
template <typename IfTrue_, typename IfFalse_>
struct Select<true, IfTrue_, IfFalse_>
{
typedef IfTrue_ Type;
};
+ /**
+ * Metaprogramming: select a type based upon a condition.
+ *
+ * \ingroup grpsr
+ */
template <typename IfTrue_, typename IfFalse_>
struct Select<false, IfTrue_, IfFalse_>
{
diff --git a/paludis/util/stringify_TEST.cc b/paludis/util/stringify_TEST.cc
index b97c4df..dff1db1 100644
--- a/paludis/util/stringify_TEST.cc
+++ b/paludis/util/stringify_TEST.cc
@@ -28,7 +28,6 @@ using namespace paludis;
/** \file
* Test cases for stringify.hh .
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -36,7 +35,6 @@ namespace test_cases
/** \test
* Test stringify on int.
*
- * \ingroup grptestcases
*/
struct StringifyIntTests : TestCase
{
@@ -55,7 +53,6 @@ namespace test_cases
/** \test
* Test stringify on char *.
*
- * \ingroup grptestcases
*/
struct StringifyCharStarTests : TestCase
{
@@ -73,7 +70,6 @@ namespace test_cases
/** \test
* Test stringify on std::string.
*
- * \ingroup grptestcases
*/
struct StringifyStringTests : TestCase
{
@@ -91,7 +87,6 @@ namespace test_cases
/** \test
* Test stringify on char.
*
- * \ingroup grptestcases
*/
struct StringifyCharTests : TestCase
{
@@ -113,7 +108,6 @@ namespace test_cases
/** \test
* Test stringify on bool.
*
- * \ingroup grptestcases
*/
struct StringifyBoolTests : TestCase
{
diff --git a/paludis/util/strip_TEST.cc b/paludis/util/strip_TEST.cc
index 54cf287..240a6d5 100644
--- a/paludis/util/strip_TEST.cc
+++ b/paludis/util/strip_TEST.cc
@@ -30,7 +30,6 @@ using namespace test;
/** \file
* Test cases for strip.hh.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -38,7 +37,6 @@ namespace test_cases
/**
* \test Test StripLeadingString.
*
- * \ingroup grptestcases
*/
struct StripLeadingStringTest : TestCase
{
@@ -59,7 +57,6 @@ namespace test_cases
/**
* \test Test StripLeading.
*
- * \ingroup grptestcases
*/
struct StripLeadingTest : TestCase
{
@@ -80,7 +77,6 @@ namespace test_cases
/**
* \test Test StripTrailingString.
*
- * \ingroup grptestcases
*/
struct StripTrailingStringTest : TestCase
{
@@ -101,7 +97,6 @@ namespace test_cases
/**
* \test Test StripTrailing.
*
- * \ingroup grptestcases
*/
struct StripTrailingTest : TestCase
{
diff --git a/paludis/util/system_TEST.cc b/paludis/util/system_TEST.cc
index e3fd16a..2b24f0c 100644
--- a/paludis/util/system_TEST.cc
+++ b/paludis/util/system_TEST.cc
@@ -26,7 +26,6 @@
/** \file
* Test cases for system.hh .
*
- * \ingroup grptestcases
*/
using namespace test;
@@ -38,7 +37,6 @@ namespace test_cases
/**
* \test Test getenv_with_default.
*
- * \ingroup grptestcases
*/
struct GetenvWithDefaultTest : TestCase
{
@@ -55,7 +53,6 @@ namespace test_cases
/**
* \test Test getenv_or_error.
*
- * \ingroup grptestcases
*/
struct GetenvOrErrorTest : TestCase
{
@@ -71,7 +68,6 @@ namespace test_cases
/**
* \test Test kernel_version.
*
- * \ingroup grptestcases
*/
struct KernelVersionTest : TestCase
{
@@ -95,7 +91,6 @@ namespace test_cases
/**
* \test Test run_command.
*
- * \ingroup grptestcases
*/
struct RunCommandTest : TestCase
{
@@ -112,7 +107,6 @@ namespace test_cases
/**
* \test Test run_command_in_directory.
*
- * \ingroup grptestcases
*/
struct RunCommandInDirectoryTest : TestCase
{
@@ -133,7 +127,6 @@ namespace test_cases
/**
* \test Test make_env_command.
*
- * \ingroup grptestcases
*/
struct MakeEnvCommandTest : TestCase
{
@@ -165,7 +158,6 @@ namespace test_cases
/**
* \test Test make_env_command with quotes.
*
- * \ingroup grptestcases
*/
struct MakeEnvCommandQuoteTest : TestCase
{
diff --git a/paludis/util/test_extras.cc b/paludis/util/test_extras.cc
index 459a324..2e44477 100644
--- a/paludis/util/test_extras.cc
+++ b/paludis/util/test_extras.cc
@@ -31,7 +31,6 @@
/** \file
* Some extras, for test cases.
*
- * \ingroup grptestcases
*/
using namespace paludis;
diff --git a/paludis/util/tokeniser_TEST.cc b/paludis/util/tokeniser_TEST.cc
index 4d91a08..d9876c4 100644
--- a/paludis/util/tokeniser_TEST.cc
+++ b/paludis/util/tokeniser_TEST.cc
@@ -29,7 +29,6 @@ using namespace paludis;
/** \file
* Test cases for tokeniser.hh .
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -37,7 +36,6 @@ namespace test_cases
/**
* \test Test Tokeniser<AnyOfTag, DelimiterTag>
*
- * \ingroup grptestcases
*/
struct TestTokeniserAD : TestCase
{
@@ -85,7 +83,6 @@ namespace test_cases
/**
* \test Test Tokeniser<AnyOfTag, BoundaryTag>
*
- * \ingroup grptestcases
*/
struct TestTokeniserAB : TestCase
{
diff --git a/paludis/util/virtual_constructor_TEST.cc b/paludis/util/virtual_constructor_TEST.cc
index 673f0c1..d53363f 100644
--- a/paludis/util/virtual_constructor_TEST.cc
+++ b/paludis/util/virtual_constructor_TEST.cc
@@ -26,7 +26,6 @@
/** \file
* Test cases for VirtualConstructor.
*
- * \ingroup grptestcases
*/
using namespace test;
@@ -139,7 +138,6 @@ namespace test_cases
/**
* \test Test VirtualConstructor.
*
- * \ingroup grptestcases
*/
struct VirtualConstructorTest : TestCase
{
@@ -167,7 +165,6 @@ namespace test_cases
/**
* \test Test VirtualConstructor keys
*
- * \ingroup grptestcases
*/
struct VirtualConstructorKeysTest : TestCase
{
diff --git a/paludis/util/visitor_TEST.cc b/paludis/util/visitor_TEST.cc
index 6e66a6a..253d7f7 100644
--- a/paludis/util/visitor_TEST.cc
+++ b/paludis/util/visitor_TEST.cc
@@ -30,7 +30,6 @@ using namespace test;
/** \file
* Test cases for visitor.hh .
*
- * \ingroup grptestcases
*/
#ifndef DOXYGEN
@@ -138,7 +137,6 @@ namespace test_cases
/**
* \test Test const visitors.
*
- * \ingroup grptestcases
*/
struct ConstVisitorTest : TestCase
{
@@ -164,7 +162,6 @@ namespace test_cases
/**
* \test Test non-const visitors.
*
- * \ingroup grptestcases
*/
struct VisitorTest : TestCase
{
diff --git a/paludis/version_operator_TEST.cc b/paludis/version_operator_TEST.cc
index 3a5634b..dfbe27a 100644
--- a/paludis/version_operator_TEST.cc
+++ b/paludis/version_operator_TEST.cc
@@ -27,7 +27,6 @@ using namespace paludis;
/** \file
* Test cases for version_operator.hh.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -35,7 +34,6 @@ namespace test_cases
/**
* \test Test VersionOperator creation and assignment.
*
- * \ingroup grptestcases
*/
struct VersionOperatorTest : TestCase
{
@@ -69,7 +67,6 @@ namespace test_cases
/**
* \test Test VersionOperator creation and assignment from a string.
*
- * \ingroup grptestcases
*/
struct VersionOperatorFromStringTest : TestCase
{
@@ -97,7 +94,6 @@ namespace test_cases
/**
* \test Test VersionOperator stringification.
*
- * \ingroup grptestcases
*/
struct VersionOperatorToStringTest : TestCase
{
diff --git a/paludis/version_spec_TEST.cc b/paludis/version_spec_TEST.cc
index 8aad736..204a9f7 100644
--- a/paludis/version_spec_TEST.cc
+++ b/paludis/version_spec_TEST.cc
@@ -29,7 +29,6 @@ using namespace paludis;
/** \file
* Test cases for VersionSpec.
*
- * \ingroup grptestcases
*/
namespace test_cases
@@ -37,7 +36,6 @@ namespace test_cases
/**
* \test Basic version_spec creation.
*
- * \ingroup grptestcases
*/
struct VersionSpecCreationTest : TestCase
{
@@ -77,7 +75,6 @@ namespace test_cases
/**
* \test Invalid version rejection
*
- * \ingroup grptestcases
*/
struct VersionSpecRejectTest : TestCase
{
@@ -99,7 +96,6 @@ namespace test_cases
/**
* \test Not so basic version_spec creation.
*
- * \ingroup grptestcases
*/
struct VersionSpecParseTest : TestCase
{
@@ -117,7 +113,6 @@ namespace test_cases
/**
* \test VersionSpec star comparisons
*
- * \ingroup grptestcases
*/
struct VersionSpecStarCompareTest : TestCase
{
@@ -143,7 +138,6 @@ namespace test_cases
/**
* \test VersionSpec tilde comparisons
*
- * \ingroup grptestcases
*/
struct VersionSpecTildeCompareTest : TestCase
{
@@ -161,7 +155,6 @@ namespace test_cases
/**
* \test VersionSpec remove revision
*
- * \ingroup grptestcases
*/
struct VersionRemoveRevisionTest : TestCase
{
@@ -178,7 +171,6 @@ namespace test_cases
/**
* \test VersionSpec revision only
*
- * \ingroup grptestcases
*/
struct VersionRevisionOnlyTest : TestCase
{
@@ -195,7 +187,6 @@ namespace test_cases
/**
* \test VersionSpec ordering.
*
- * \ingroup grptestcases
*/
struct VersionSpecCompareSCMTest : TestCase
{
diff --git a/test/test_fail_TEST.cc b/test/test_fail_TEST.cc
index 46d04c1..1f1e7e2 100644
--- a/test/test_fail_TEST.cc
+++ b/test/test_fail_TEST.cc
@@ -26,7 +26,7 @@ using namespace test;
/** \file
* This test should fail.
*
- * \ingroup Test
+ * \ingroup grptestframework
*/
namespace test_cases
diff --git a/test/test_framework.cc b/test/test_framework.cc
index e34798e..065688c 100644
--- a/test/test_framework.cc
+++ b/test/test_framework.cc
@@ -27,7 +27,7 @@
/** \file
* Implementation for test framework classes.
*
- * \ingroup Test
+ * \ingroup grptestframework
*/
using namespace test;
diff --git a/test/test_framework.hh b/test/test_framework.hh
index ee93d00..e9768bb 100644
--- a/test/test_framework.hh
+++ b/test/test_framework.hh
@@ -27,7 +27,7 @@
/** \file
* Test framework class definitions.
*
- * \ingroup Test
+ * \ingroup grptestframework
*/
namespace test
@@ -35,7 +35,7 @@ namespace test
/**
* RAII suffix marker for TestCase context.
*
- * \ingroup Test
+ * \ingroup grptestframework
*/
class TestMessageSuffix :
paludis::PrivateImplementationPattern<TestMessageSuffix>
@@ -60,7 +60,7 @@ namespace test
/**
* Base TestCase class.
*
- * \ingroup Test
+ * \ingroup grptestframework
*/
class TestCase :
private paludis::PrivateImplementationPattern<TestCase>
@@ -126,7 +126,7 @@ namespace test
/**
* Thrown if a TestCase failed.
*
- * \ingroup Test
+ * \ingroup grptestframework
* \ingroup grpexceptions
*/
class TestFailedException : public std::exception
@@ -158,7 +158,7 @@ namespace test
/**
* A list of TestCase instances.
*
- * \ingroup Test
+ * \ingroup grptestframework
*/
class TestCaseList
{
diff --git a/test/test_pass_TEST.cc b/test/test_pass_TEST.cc
index 9aff24e..d8bb088 100644
--- a/test/test_pass_TEST.cc
+++ b/test/test_pass_TEST.cc
@@ -26,7 +26,7 @@ using namespace test;
/** \file
* This test should pass.
*
- * \ingroup Test
+ * \ingroup grptestframework
*/
namespace test_cases
@@ -34,7 +34,7 @@ namespace test_cases
/**
* \test This test should pass.
*
- * \ingroup Test
+ * \ingroup grptestframework
*/
struct PassTest : TestCase
{
diff --git a/test/test_runner.cc b/test/test_runner.cc
index 4e78d01..38100e2 100644
--- a/test/test_runner.cc
+++ b/test/test_runner.cc
@@ -34,7 +34,7 @@
/** \file
* Implementation of the default test runner.
*
- * \ingroup Test
+ * \ingroup grptestframework
*/
using namespace test;