aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-20 01:59:09 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-20 01:59:09 +0000
commit81e10024fc3ab2d8e6e4b6fed899b4e985b1a98d (patch)
treebd10633228794346d087f32f45202c6d32ea2fe3
parenta01468df8cd58bc0f559fa1ad9e77932b49c6821 (diff)
downloadpaludis-81e10024fc3ab2d8e6e4b6fed899b4e985b1a98d.tar.gz
paludis-81e10024fc3ab2d8e6e4b6fed899b4e985b1a98d.tar.xz
More Doxygen updates.
-rw-r--r--doc/doc_main.doxygen2
-rw-r--r--paludis/create_insert_iterator.hh4
-rw-r--r--paludis/default_config_error.hh12
-rw-r--r--paludis/dep_list.cc2
-rw-r--r--paludis/is_file_with_extension.cc6
-rw-r--r--paludis/is_file_with_extension.hh22
6 files changed, 48 insertions, 0 deletions
diff --git a/doc/doc_main.doxygen b/doc/doc_main.doxygen
index f30e12a..2d649ca 100644
--- a/doc/doc_main.doxygen
+++ b/doc/doc_main.doxygen
@@ -139,6 +139,8 @@
*
* - paludis::FSEntry represents a filesystem entry.
* - paludis::DirIterator is an iterator for directories.
+ * - paludis::IsFileWithExtension can be used as a functor to determine
+ * whether a paludis::FSEntry instance is a file with certain attributes.
*
* \ingroup Utility
*/
diff --git a/paludis/create_insert_iterator.hh b/paludis/create_insert_iterator.hh
index b49eb23..c2240d7 100644
--- a/paludis/create_insert_iterator.hh
+++ b/paludis/create_insert_iterator.hh
@@ -40,6 +40,10 @@ namespace paludis
Iter_ _i;
public:
+ /**
+ * Fake a container_type to allow us to work with other iterator
+ * adapters.
+ */
struct container_type
{
typedef Type_ value_type;
diff --git a/paludis/default_config_error.hh b/paludis/default_config_error.hh
index 86a72d1..6f3a4b7 100644
--- a/paludis/default_config_error.hh
+++ b/paludis/default_config_error.hh
@@ -23,8 +23,20 @@
#include <paludis/configuration_error.hh>
+/** \file
+ * Declarations for the DefaultConfigError class.
+ *
+ * \ingroup Exception
+ */
+
namespace paludis
{
+ /**
+ * A DefaultConfigError is thrown if a configuration error is encountered
+ * by DefaultConfig.
+ *
+ * \ingroup Exception
+ */
class DefaultConfigError : public ConfigurationError
{
public:
diff --git a/paludis/dep_list.cc b/paludis/dep_list.cc
index f9aca2c..b6846da 100644
--- a/paludis/dep_list.cc
+++ b/paludis/dep_list.cc
@@ -311,6 +311,7 @@ DepList::visit(const UseDepAtom * const u)
std::for_each(u->begin(), u->end(), std::bind1st(std::mem_fun(&DepList::add), this));
}
+#ifndef DOXYGEN
struct IsViable :
public std::unary_function<bool, DepAtom::ConstPointer>
{
@@ -332,6 +333,7 @@ struct IsViable :
return true;
}
};
+#endif
void
DepList::visit(const AnyDepAtom * const a)
diff --git a/paludis/is_file_with_extension.cc b/paludis/is_file_with_extension.cc
index 97397dc..6f7b140 100644
--- a/paludis/is_file_with_extension.cc
+++ b/paludis/is_file_with_extension.cc
@@ -22,6 +22,12 @@
using namespace paludis;
+/** \file
+ * Implementation of IsFileWithExtension.
+ *
+ * \ingroup Filesystem
+ */
+
bool
IsFileWithExtension::operator() (const FSEntry & f) const
{
diff --git a/paludis/is_file_with_extension.hh b/paludis/is_file_with_extension.hh
index 659a5e8..c74668a 100644
--- a/paludis/is_file_with_extension.hh
+++ b/paludis/is_file_with_extension.hh
@@ -25,8 +25,21 @@
#include <string>
#include <functional>
+/** \file
+ * Declarations for the IsFileWithExtension class.
+ *
+ * \ingroup Filesystem
+ */
+
namespace paludis
{
+ /**
+ * The IsFileWithExtension class is a functor that determines whether an
+ * FSEntry instance is a file with a given extension and (optionally) a
+ * given filename prefix.
+ *
+ * \ingroup Filesystem
+ */
class IsFileWithExtension :
public std::unary_function<bool, FSEntry>
{
@@ -35,18 +48,27 @@ namespace paludis
const std::string _ext;
public:
+ /**
+ * Constructor.
+ */
IsFileWithExtension(const std::string & ext) :
_prefix(""),
_ext(ext)
{
}
+ /**
+ * Constructor.
+ */
IsFileWithExtension(const std::string & prefix, const std::string & ext) :
_prefix(prefix),
_ext(ext)
{
}
+ /**
+ * Operator.
+ */
bool operator() (const FSEntry & f) const;
};
}