aboutsummaryrefslogtreecommitdiff
path: root/paludis/contents.hh
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-07-08 20:40:58 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-07-08 20:40:58 +0000
commit305d994f62cd55fbeba135b409326714a4d28bff (patch)
treecfc27a8ede5a2589ec92c36a95ea24994f79a6cc /paludis/contents.hh
parent2244241855948aad91cdfeaefad92e304e9a9ad8 (diff)
downloadpaludis-305d994f62cd55fbeba135b409326714a4d28bff.tar.gz
paludis-305d994f62cd55fbeba135b409326714a4d28bff.tar.xz
Doxygen improvements
Diffstat (limited to 'paludis/contents.hh')
-rw-r--r--paludis/contents.hh12
1 files changed, 12 insertions, 0 deletions
diff --git a/paludis/contents.hh b/paludis/contents.hh
index 82dc470..bfdb9e0 100644
--- a/paludis/contents.hh
+++ b/paludis/contents.hh
@@ -62,14 +62,17 @@ namespace paludis
std::string _name;
protected:
+ /// Constructor.
ContentsEntry(const std::string & name) :
_name(name)
{
}
public:
+ /// Destructor.
virtual ~ContentsEntry();
+ /// Our name.
std::string name() const
{
return _name;
@@ -86,6 +89,7 @@ namespace paludis
public Visitable<ContentsFileEntry, ContentsVisitorTypes>
{
public:
+ /// Constructor.
ContentsFileEntry(const std::string & name);
};
@@ -99,6 +103,7 @@ namespace paludis
public Visitable<ContentsDirEntry, ContentsVisitorTypes>
{
public:
+ /// Constructor.
ContentsDirEntry(const std::string & name);
};
@@ -112,6 +117,7 @@ namespace paludis
public Visitable<ContentsMiscEntry, ContentsVisitorTypes>
{
public:
+ /// Constructor.
ContentsMiscEntry(const std::string & name);
};
@@ -128,8 +134,10 @@ namespace paludis
std::string _target;
public:
+ /// Constructor.
ContentsSymEntry(const std::string & name, const std::string & target);
+ /// Our target (as per readlink).
std::string target() const
{
return _target;
@@ -151,18 +159,22 @@ namespace paludis
public:
Contents();
+ /// Add a new entry.
void add(ContentsEntry::ConstPointer c)
{
_c.push_back(c);
}
+ /// Iterator over our entries.
typedef std::list<ContentsEntry::ConstPointer>::const_iterator Iterator;
+ /// Start of our entries.
Iterator begin() const
{
return _c.begin();
}
+ /// End of our entries.
Iterator end() const
{
return _c.end();