aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2011-07-16 14:03:15 +0100
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2011-07-16 14:03:15 +0100
commit031c98dfc6043c73bfde593a8252113788b15b3c (patch)
treec3afdcad773265a769a5ea1857a1b762c7923e15
parentc23857618921c622d6227ba5e0e88487031ac06c (diff)
downloadpaludis-031c98dfc6043c73bfde593a8252113788b15b3c.tar.gz
paludis-031c98dfc6043c73bfde593a8252113788b15b3c.tar.xz
Doxygenate
-rw-r--r--paludis/slot_requirement.hh36
1 files changed, 36 insertions, 0 deletions
diff --git a/paludis/slot_requirement.hh b/paludis/slot_requirement.hh
index 993be11..a0b7a1d 100644
--- a/paludis/slot_requirement.hh
+++ b/paludis/slot_requirement.hh
@@ -27,29 +27,65 @@
namespace paludis
{
+ /**
+ * A SlotRequirement represents a PackageDepSpec's slot
+ * requirement, such as <code>:3</code>, <code>:*</code>,
+ * <code>:=</code> or <code>:=3</code>.
+ *
+ * \ingroup g_dep_spec
+ */
class PALUDIS_VISIBLE SlotRequirement :
public virtual DeclareAbstractAcceptMethods<SlotRequirement, MakeTypeList<
SlotExactRequirement, SlotAnyLockedRequirement, SlotAnyUnlockedRequirement>::Type>
{
public:
+ /**
+ * String representation, including the leading colon. Not suitable
+ * for parsing.
+ */
virtual const std::string as_string() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
};
+ /**
+ * A SlotExactRequirement is a SlotRequirement for exact
+ * slot requirements, such as <code>:3</code> or <code>:=3</code>.
+ *
+ * \ingroup g_dep_spec
+ */
class PALUDIS_VISIBLE SlotExactRequirement :
public SlotRequirement,
public ImplementAcceptMethods<SlotRequirement, SlotExactRequirement>
{
public:
+ /**
+ * The slot in question.
+ */
virtual const SlotName slot() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
+
+ /**
+ * If true, indicates we are a <code>:=3</code> style dependency.
+ */
virtual bool from_any_locked() const PALUDIS_ATTRIBUTE((warn_unused_result)) = 0;
};
+ /**
+ * A SlotAnyLockedRequirement is a SlotRequirement for
+ * <code>:=</code> slot requirements.
+ *
+ * \ingroup g_dep_spec
+ */
class PALUDIS_VISIBLE SlotAnyLockedRequirement :
public SlotRequirement,
public ImplementAcceptMethods<SlotRequirement, SlotAnyLockedRequirement>
{
};
+ /**
+ * A SlotAnyLockedRequirement is a SlotRequirement for
+ * <code>:*</code> slot requirements.
+ *
+ * \ingroup g_dep_spec
+ */
class PALUDIS_VISIBLE SlotAnyUnlockedRequirement :
public SlotRequirement,
public ImplementAcceptMethods<SlotRequirement, SlotAnyUnlockedRequirement>