aboutsummaryrefslogtreecommitdiff
path: root/paludis/generator-fwd.hh
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-03-05 22:42:11 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2010-03-05 22:42:11 +0000
commit7a58de7637da67d8420cab0b69c79bbb376a5688 (patch)
treec05a5951939608c4d647af0f60c580f04d815cde /paludis/generator-fwd.hh
parentfcbbe6ab11f7ebae5fdbf5aca8ec6d8fef8614c2 (diff)
downloadpaludis-7a58de7637da67d8420cab0b69c79bbb376a5688.tar.gz
paludis-7a58de7637da67d8420cab0b69c79bbb376a5688.tar.xz
Doxygenate selections etc
Diffstat (limited to 'paludis/generator-fwd.hh')
-rw-r--r--paludis/generator-fwd.hh26
1 files changed, 25 insertions, 1 deletions
diff --git a/paludis/generator-fwd.hh b/paludis/generator-fwd.hh
index 48bc9cbcd..4629ac85f 100644
--- a/paludis/generator-fwd.hh
+++ b/paludis/generator-fwd.hh
@@ -1,7 +1,7 @@
/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
- * Copyright (c) 2008, 2009 Ciaran McCreesh
+ * Copyright (c) 2008, 2009, 2010 Ciaran McCreesh
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
@@ -23,6 +23,12 @@
#include <paludis/util/attributes.hh>
#include <iosfwd>
+/** \file
+ * Forward declarations for paludis/generator.hh .
+ *
+ * \ingroup g_selections
+ */
+
namespace paludis
{
class Generator;
@@ -40,12 +46,30 @@ namespace paludis
template <typename> class SomeIDsMightSupportAction;
}
+ /**
+ * Two Generator instances can be and-ed together, to obtain only PackageID
+ * instances that satisfy the constraints of Generator instances.
+ *
+ * \ingroup g_selections
+ */
Generator operator& (const Generator &, const Generator &)
PALUDIS_ATTRIBUTE((warn_unused_result)) PALUDIS_VISIBLE;
+ /**
+ * Two Generator instances can be added, to obtain PackageID instances that
+ * satisfy the constraints of either Generator instance.
+ *
+ * \ingroup g_selections
+ */
Generator operator+ (const Generator &, const Generator &)
PALUDIS_ATTRIBUTE((warn_unused_result)) PALUDIS_VISIBLE;
+ /**
+ * A FilteredGenerator can be represented as a string. Generally this is
+ * used only for stringifying a Selection.
+ *
+ * \ingroup g_selections
+ */
std::ostream & operator<< (std::ostream &, const Generator &)
PALUDIS_VISIBLE;
}