aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-01-01 19:20:52 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-01-01 19:20:52 +0000
commite3098b9e7c78568e603429476ae0445185e7c1b3 (patch)
tree9587d3a15f04b7b76cb806bfa3e1066140fc45a8
parent4b2cbbe662e44baf551dabd06af2a38bacf3d383 (diff)
downloadpaludis-e3098b9e7c78568e603429476ae0445185e7c1b3.tar.gz
paludis-e3098b9e7c78568e603429476ae0445185e7c1b3.tar.xz
Doxygen tweaks
-rw-r--r--paludis/qa/ebuild_check.hh7
-rw-r--r--paludis/qa/per_profile_ebuild_check.hh7
-rw-r--r--paludis/repositories/portage/use_desc.hh17
-rw-r--r--paludis/repositories/repository_maker.hh16
-rw-r--r--paludis/util/collection_concrete.hh7
5 files changed, 48 insertions, 6 deletions
diff --git a/paludis/qa/ebuild_check.hh b/paludis/qa/ebuild_check.hh
index b7cc839..f50d68a 100644
--- a/paludis/qa/ebuild_check.hh
+++ b/paludis/qa/ebuild_check.hh
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -81,6 +81,11 @@ namespace paludis
}
};
+ /**
+ * Virtual constructor for ebuild checks.
+ *
+ * \ingroup grpqa
+ */
class EbuildCheckMaker :
public VirtualConstructor<std::string, EbuildCheck::Pointer (*) (),
virtual_constructor_not_found::ThrowException<NoSuchEbuildCheckTypeError> >,
diff --git a/paludis/qa/per_profile_ebuild_check.hh b/paludis/qa/per_profile_ebuild_check.hh
index 78576ef..76449be 100644
--- a/paludis/qa/per_profile_ebuild_check.hh
+++ b/paludis/qa/per_profile_ebuild_check.hh
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -82,6 +82,11 @@ namespace paludis
}
};
+ /**
+ * Virtual constructor for per profile checks.
+ *
+ * \ingroup grpqa
+ */
class PerProfileEbuildCheckMaker :
public VirtualConstructor<std::string, PerProfileEbuildCheck::Pointer (*) (),
virtual_constructor_not_found::ThrowException<NoSuchPerProfileEbuildCheckTypeError> >,
diff --git a/paludis/repositories/portage/use_desc.hh b/paludis/repositories/portage/use_desc.hh
index 0881b65..ad17d60 100644
--- a/paludis/repositories/portage/use_desc.hh
+++ b/paludis/repositories/portage/use_desc.hh
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -30,15 +30,30 @@ namespace paludis
class FSEntry;
class PackageDatabaseEntry;
+ /**
+ * Implements use.desc options for PortageRepository.
+ *
+ * \ingroup grpportagerepository
+ */
class UseDesc :
private PrivateImplementationPattern<UseDesc>,
private InstantiationPolicy<UseDesc, instantiation_method::NonCopyableTag>,
public InternalCounted<UseDesc>
{
public:
+ ///\name Basic operations
+ ///\{
+
UseDesc(const FSEntry &);
~UseDesc();
+ ///\}
+
+ /**
+ * Describe the given use flag, possibly for the specified package.
+ *
+ * May return an empty string.
+ */
std::string describe(const UseFlagName &, const PackageDatabaseEntry * const) const;
};
}
diff --git a/paludis/repositories/repository_maker.hh b/paludis/repositories/repository_maker.hh
index bc154c8..9134495 100644
--- a/paludis/repositories/repository_maker.hh
+++ b/paludis/repositories/repository_maker.hh
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -29,6 +29,12 @@ namespace paludis
{
class FSEntry;
+ /**
+ * Thrown if PALUDIS_REPOSITORY_SO_DIR is not a directory.
+ *
+ * \ingroup grpexceptions
+ * \ingroup grprepository
+ */
class PALUDIS_VISIBLE PaludisRepositorySoDirNotADirectoryError :
public Exception
{
@@ -36,6 +42,12 @@ namespace paludis
PaludisRepositorySoDirNotADirectoryError() throw ();
};
+ /**
+ * Thrown if a repository .so cannot be used.
+ *
+ * \ingroup grpexceptions
+ * \ingroup grprepository
+ */
class PaludisRepositorySoDirCannotDlopenError :
public Exception
{
@@ -52,7 +64,7 @@ namespace paludis
const char * what() const throw ();
};
- /*
+ /**
* Virtual constructor for repositories.
*
* \ingroup grprepository
diff --git a/paludis/util/collection_concrete.hh b/paludis/util/collection_concrete.hh
index 8ab332f..c5d560e 100644
--- a/paludis/util/collection_concrete.hh
+++ b/paludis/util/collection_concrete.hh
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2005, 2006 Ciaran McCreesh <ciaranm@ciaranm.org>
+ * Copyright (c) 2005, 2006, 2007 Ciaran McCreesh <ciaranm@ciaranm.org>
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -127,8 +127,13 @@ namespace paludis
//\}
+ ///\name Pointer types
+ ///\{
+
typedef CountedPtr<Concrete, count_policy::InternalCountTag> ConstPointer;
typedef CountedPtr<Concrete, count_policy::InternalCountTag> Pointer;
+
+ ///\}
};
/**