aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Richard Brown <rbrown@exherbo.org> 2007-05-02 16:49:17 +0000
committerAvatar Richard Brown <rbrown@exherbo.org> 2007-05-02 16:49:17 +0000
commitb426a95e708a128f592142e44facab2eeb9c3d9e (patch)
treead338d691ad23630bde7408a7485f87104becb4e
parent514f909d700f40416ea8f3ff3ac4e223afcabcf0 (diff)
downloadpaludis-b426a95e708a128f592142e44facab2eeb9c3d9e.tar.gz
paludis-b426a95e708a128f592142e44facab2eeb9c3d9e.tar.xz
Document AdaptedEnvironment
-rw-r--r--doc/doxygen.conf.in2
-rw-r--r--paludis/environments/adapted/adapted_environment.hh15
2 files changed, 16 insertions, 1 deletions
diff --git a/doc/doxygen.conf.in b/doc/doxygen.conf.in
index e2d9965..25fcdf2 100644
--- a/doc/doxygen.conf.in
+++ b/doc/doxygen.conf.in
@@ -461,7 +461,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ../paludis ../paludis/args ../paludis/dep_list ../paludis/digests ../paludis/environments ../paludis/environments/no_config ../paludis/environments/portage ../paludis/environments/paludis ../paludis/environments/test ../paludis/fetchers ../paludis/merger ../paludis/qa ../paludis/repositories ../paludis/repositories/cran ../paludis/repositories/fake ../paludis/repositories/gentoo ../paludis/repositories/virtuals ../paludis/selinux ../paludis/syncers ../paludis/tasks ../paludis/util ../doc
+INPUT = ../paludis ../paludis/args ../paludis/dep_list ../paludis/digests ../paludis/environments ../paludis/environments/no_config ../paludis/environments/adapted ../paludis/environments/portage ../paludis/environments/paludis ../paludis/environments/test ../paludis/fetchers ../paludis/merger ../paludis/qa ../paludis/repositories ../paludis/repositories/cran ../paludis/repositories/fake ../paludis/repositories/gentoo ../paludis/repositories/virtuals ../paludis/selinux ../paludis/syncers ../paludis/tasks ../paludis/util ../doc
# 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/environments/adapted/adapted_environment.hh b/paludis/environments/adapted/adapted_environment.hh
index 2ac0760..35a67f9 100644
--- a/paludis/environments/adapted/adapted_environment.hh
+++ b/paludis/environments/adapted/adapted_environment.hh
@@ -26,6 +26,14 @@ namespace paludis
{
class PackageDepSpec;
+ /**
+ * An Environment that allows you to change aspects of an
+ * existing Environment, e.g.\ the state of a USE flag for a
+ * package.
+ *
+ * \ingroup grpadaptedenvironment
+ * \nosubgrouping
+ */
class AdaptedEnvironment :
public Environment,
private PrivateImplementationPattern<AdaptedEnvironment>
@@ -37,7 +45,14 @@ namespace paludis
///\name Adapting methods
///\{
+ /**
+ * Set the state of a USE flag for the given PackageDepSpec
+ */
void adapt_use(std::tr1::shared_ptr<const PackageDepSpec>, const UseFlagName &, const UseFlagState);
+
+ /**
+ * Clear all adaptions from this Environemnt.
+ */
void clear_adaptions();
///\}