aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-07-30 00:20:50 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-07-30 00:20:50 +0000
commitca3f58688e98b472e2ea306933f4a4a0fd7cf1ef (patch)
treec93f1ae2f59d8254a42c0c4693a81792fa6f5f18
parent8e82dd8f89b63c33ae18ad91c093a245395ccc1d (diff)
downloadpaludis-ca3f58688e98b472e2ea306933f4a4a0fd7cf1ef.tar.gz
paludis-ca3f58688e98b472e2ea306933f4a4a0fd7cf1ef.tar.xz
Doxygen improvements
-rw-r--r--paludis/args/args_group.cc5
-rw-r--r--paludis/args/args_handler.cc5
-rw-r--r--paludis/args/args_option.cc15
-rw-r--r--paludis/config_file.cc15
-rw-r--r--paludis/contents.cc5
-rw-r--r--paludis/dep_atom.cc10
-rw-r--r--paludis/dep_atom_flattener.cc5
-rw-r--r--paludis/environment.hh25
-rw-r--r--paludis/package_database.cc9
-rw-r--r--paludis/portage_dep_lexer.cc5
-rw-r--r--paludis/repositories/portage/portage_repository.cc1
-rw-r--r--paludis/repositories/portage/portage_repository_ebuild_entries.cc5
-rw-r--r--paludis/repositories/portage/portage_repository_ebuild_entries.hh5
-rw-r--r--paludis/repositories/portage/portage_repository_entries.hh25
-rw-r--r--paludis/repositories/portage/portage_repository_news.cc10
-rw-r--r--paludis/repositories/portage/portage_repository_sets.cc5
-rw-r--r--paludis/repository.cc10
-rw-r--r--paludis/util/dir_iterator.cc5
-rw-r--r--paludis/util/fd_output_stream.hh19
-rw-r--r--paludis/util/pipe.hh10
20 files changed, 191 insertions, 3 deletions
diff --git a/paludis/args/args_group.cc b/paludis/args/args_group.cc
index 2926e91..56a776b 100644
--- a/paludis/args/args_group.cc
+++ b/paludis/args/args_group.cc
@@ -30,6 +30,11 @@ using namespace paludis::args;
namespace paludis
{
+ /**
+ * Implementation data for ArgsGroup.
+ *
+ * \ingroup grplibpaludisargs
+ */
template<>
struct Implementation<ArgsGroup> :
InternalCounted<ArgsGroup>
diff --git a/paludis/args/args_handler.cc b/paludis/args/args_handler.cc
index 16c2267..064bad8 100644
--- a/paludis/args/args_handler.cc
+++ b/paludis/args/args_handler.cc
@@ -35,6 +35,11 @@ using namespace paludis::args;
namespace paludis
{
+ /**
+ * Implementation data for ArgsHandler.
+ *
+ * \ingroup grplibpaludisargs
+ */
template<>
struct Implementation<ArgsHandler> :
InternalCounted<Implementation<ArgsHandler> >
diff --git a/paludis/args/args_option.cc b/paludis/args/args_option.cc
index c195820..990fb32 100644
--- a/paludis/args/args_option.cc
+++ b/paludis/args/args_option.cc
@@ -71,6 +71,11 @@ StringArg::StringArg(ArgsGroup * const g, const std::string & long_name,
namespace paludis
{
+ /**
+ * Implementation data for StringSetArg.
+ *
+ * \ingroup grplibpaludisargs
+ */
template<>
struct Implementation<StringSetArg> :
InternalCounted<Implementation<StringSetArg> >
@@ -138,6 +143,11 @@ namespace
namespace paludis
{
+ /**
+ * Implementation data for EnumArg.
+ *
+ * \ingroup grplibpaludisargs
+ */
template<>
struct Implementation<EnumArg> :
InternalCounted<Implementation<EnumArg> >
@@ -145,6 +155,11 @@ namespace paludis
std::vector<std::pair<std::string, std::string> > allowed_args;
};
+ /**
+ * Implementation data for EnumArg::EnumArgOptions.
+ *
+ * \ingroup grplibpaludisargs
+ */
template<>
struct Implementation<EnumArg::EnumArgOptions> :
InternalCounted<Implementation<EnumArg::EnumArgOptions> >
diff --git a/paludis/config_file.cc b/paludis/config_file.cc
index 7800ad5..b6cdd1c 100644
--- a/paludis/config_file.cc
+++ b/paludis/config_file.cc
@@ -151,6 +151,11 @@ ConfigFile::skip_line(const std::string & s) const
namespace paludis
{
+ /**
+ * Implementation data for LineConfigFile.
+ *
+ * \ingroup grplineconfigfile
+ */
template<>
struct Implementation<LineConfigFile> :
InternalCounted<Implementation<LineConfigFile> >
@@ -211,6 +216,11 @@ KeyValueConfigFileError::KeyValueConfigFileError(const std::string & msg,
namespace paludis
{
+ /**
+ * Implementation data for KeyValueConfigFile.
+ *
+ * \ingroup grpkvconfigfile
+ */
template <>
struct Implementation<KeyValueConfigFile> :
InternalCounted<Implementation<KeyValueConfigFile> >
@@ -382,6 +392,11 @@ AdvisoryFileError::AdvisoryFileError(const std::string & msg,
namespace paludis
{
+ /**
+ * Implementation data for AdvisoryFile.
+ *
+ * \ingroup grpadvisoryconfigfile
+ */
template<>
struct Implementation<AdvisoryFile> :
InternalCounted<Implementation<AdvisoryFile> >
diff --git a/paludis/contents.cc b/paludis/contents.cc
index 6429624..892ae15 100644
--- a/paludis/contents.cc
+++ b/paludis/contents.cc
@@ -55,6 +55,11 @@ ContentsSymEntry::ContentsSymEntry(const std::string & name, const std::string &
namespace paludis
{
+ /**
+ * Implementation data for Contents.
+ *
+ * \ingroup grpcontents
+ */
template<>
struct Implementation<Contents> :
InternalCounted<Implementation<Contents> >
diff --git a/paludis/dep_atom.cc b/paludis/dep_atom.cc
index 07d4583..e63d2fa 100644
--- a/paludis/dep_atom.cc
+++ b/paludis/dep_atom.cc
@@ -47,6 +47,11 @@ DepAtom::as_use_dep_atom() const
namespace paludis
{
+ /**
+ * Implementation data for CompositeDepAtom.
+ *
+ * \ingroup grpdepatoms
+ */
template<>
struct Implementation<CompositeDepAtom> :
InternalCounted<Implementation<CompositeDepAtom> >
@@ -306,6 +311,11 @@ PlainTextDepAtom::PlainTextDepAtom(const std::string & s) :
namespace paludis
{
+ /**
+ * Implementation data for UseRequirements.
+ *
+ * \ingroup grpdepatoms
+ */
template<>
struct Implementation<UseRequirements> :
InternalCounted<Implementation<UseRequirements> >
diff --git a/paludis/dep_atom_flattener.cc b/paludis/dep_atom_flattener.cc
index 8aa5ae7..5965caf 100644
--- a/paludis/dep_atom_flattener.cc
+++ b/paludis/dep_atom_flattener.cc
@@ -31,6 +31,11 @@ using namespace paludis;
namespace paludis
{
+ /**
+ * Implementation data for DepAtomFlattener.
+ *
+ * \ingroup grpdepatomflattener
+ */
template<>
struct Implementation<DepAtomFlattener> :
InternalCounted<Implementation<DepAtomFlattener> >
diff --git a/paludis/environment.hh b/paludis/environment.hh
index 82ab219..649e38b 100644
--- a/paludis/environment.hh
+++ b/paludis/environment.hh
@@ -215,27 +215,52 @@ namespace paludis
DepAtom::Pointer package_set(const std::string &,
const PackageSetOptions & = PackageSetOptions(false)) const;
+ /**
+ * Subclass for callbacks used by add_appropriate_to_world and
+ * remove_appropriate_from_world.
+ *
+ * \ingroup grpenvironment
+ */
class WorldCallbacks
{
protected:
+ ///\name Basic operations
+ ///\{
+
WorldCallbacks()
{
}
+ ///\}
+
public:
+ ///\name Basic operations
+ ///\{
+
virtual ~WorldCallbacks()
{
}
+ ///\}
+
+ /**
+ * Called when adding an entry to world.
+ */
virtual void add_callback(const PackageDepAtom *)
{
}
+ /**
+ * Called when skipping adding an entry to world.
+ */
virtual void skip_callback(const PackageDepAtom *,
const std::string &)
{
}
+ /**
+ * Called when removing an entry to world.
+ */
virtual void remove_callback(const PackageDepAtom *)
{
}
diff --git a/paludis/package_database.cc b/paludis/package_database.cc
index 1f40f77..57e3579 100644
--- a/paludis/package_database.cc
+++ b/paludis/package_database.cc
@@ -73,13 +73,20 @@ NoSuchVersionError::NoSuchVersionError(const std::string & name,
{
}
+/**
+ * Name data for an AmbiguousPackageNameError.
+ *
+ * \ingroup grpexceptions
+ */
struct AmbiguousPackageNameError::NameData
{
+ /// Our query name
std::string name;
+
+ /// Our match names
std::list<std::string> names;
};
-
template <typename I_>
AmbiguousPackageNameError::AmbiguousPackageNameError(const std::string & name,
I_ begin, const I_ end) throw () :
diff --git a/paludis/portage_dep_lexer.cc b/paludis/portage_dep_lexer.cc
index da5a19a..7feb422 100644
--- a/paludis/portage_dep_lexer.cc
+++ b/paludis/portage_dep_lexer.cc
@@ -34,6 +34,11 @@ using namespace paludis;
namespace paludis
{
+ /**
+ * Implementation data for PortageDepLexer.
+ *
+ * \ingroup grpdeplexer
+ */
template<>
struct Implementation<PortageDepLexer> :
InternalCounted<Implementation<PortageDepLexer> >
diff --git a/paludis/repositories/portage/portage_repository.cc b/paludis/repositories/portage/portage_repository.cc
index 32f968f..103ae8c 100644
--- a/paludis/repositories/portage/portage_repository.cc
+++ b/paludis/repositories/portage/portage_repository.cc
@@ -71,6 +71,7 @@ using namespace paludis;
namespace paludis
{
+ /// Set of use flags.
typedef MakeHashedSet<UseFlagName>::Type UseFlagSet;
/// Map for versions.
diff --git a/paludis/repositories/portage/portage_repository_ebuild_entries.cc b/paludis/repositories/portage/portage_repository_ebuild_entries.cc
index 917c88e..5a0c75c 100644
--- a/paludis/repositories/portage/portage_repository_ebuild_entries.cc
+++ b/paludis/repositories/portage/portage_repository_ebuild_entries.cc
@@ -39,6 +39,11 @@ using namespace paludis;
namespace paludis
{
+ /**
+ * Implementation data for PortageRepositoryEbuildEntries.
+ *
+ * \ingroup grpportagerepository
+ */
template<>
struct Implementation<PortageRepositoryEbuildEntries> :
InternalCounted<Implementation<PortageRepositoryEbuildEntries> >
diff --git a/paludis/repositories/portage/portage_repository_ebuild_entries.hh b/paludis/repositories/portage/portage_repository_ebuild_entries.hh
index 97ef9d0..003a07b 100644
--- a/paludis/repositories/portage/portage_repository_ebuild_entries.hh
+++ b/paludis/repositories/portage/portage_repository_ebuild_entries.hh
@@ -35,6 +35,11 @@ namespace paludis
class FSEntry;
class PortageRepository;
+ /**
+ * PortageRepositoryEntries handler for ebuilds.
+ *
+ * \ingroup grpportagerepository
+ */
class PortageRepositoryEbuildEntries :
public PortageRepositoryEntries,
private PrivateImplementationPattern<PortageRepositoryEbuildEntries>
diff --git a/paludis/repositories/portage/portage_repository_entries.hh b/paludis/repositories/portage/portage_repository_entries.hh
index 3a59a10..0be77f3 100644
--- a/paludis/repositories/portage/portage_repository_entries.hh
+++ b/paludis/repositories/portage/portage_repository_entries.hh
@@ -42,6 +42,11 @@ namespace paludis
class PortageRepository;
class Environment;
+ /**
+ * Handle entries (for example, ebuilds) in a PortageRepository.
+ *
+ * \ingroup grpportagerepository
+ */
class PortageRepositoryEntries :
public InternalCounted<PortageRepositoryEntries>
{
@@ -49,19 +54,39 @@ namespace paludis
const std::string _ext;
protected:
+ ///\name Basic operations
+ ///\{
+
+ /// Constructor, with our file extension
PortageRepositoryEntries(const std::string & ext);
+ ///\}
+
public:
+ ///\name Basic operations
+ ///\{
+
virtual ~PortageRepositoryEntries();
+ ///\}
+
+ /**
+ * Return our file extension, including the dot.
+ */
std::string file_extension() const
{
return _ext;
}
+ /**
+ * Generate version metadata.
+ */
virtual VersionMetadata::Pointer generate_version_metadata(const QualifiedPackageName &,
const VersionSpec &) const = 0;
+ /**
+ * Fetch an environment variable.
+ */
virtual std::string get_environment_variable(const QualifiedPackageName &,
const VersionSpec &, const std::string & var,
PortageRepositoryProfile::ConstPointer) const = 0;
diff --git a/paludis/repositories/portage/portage_repository_news.cc b/paludis/repositories/portage/portage_repository_news.cc
index fdfb717..a05fece 100644
--- a/paludis/repositories/portage/portage_repository_news.cc
+++ b/paludis/repositories/portage/portage_repository_news.cc
@@ -36,6 +36,11 @@ using namespace paludis;
namespace paludis
{
+ /**
+ * Implementation data for PortageRepositoryNews.
+ *
+ * \ingroup grpportagerepository
+ */
template<>
struct Implementation<PortageRepositoryNews> :
InternalCounted<Implementation<PortageRepositoryNews> >
@@ -186,6 +191,11 @@ PortageRepositoryNews::update_news() const
namespace paludis
{
+ /**
+ * Implementation data for NewsFile.
+ *
+ * \ingroup grpnewsconfigfile
+ */
template<>
struct Implementation<NewsFile> :
InternalCounted<Implementation<NewsFile> >
diff --git a/paludis/repositories/portage/portage_repository_sets.cc b/paludis/repositories/portage/portage_repository_sets.cc
index 941a570..d8884b1 100644
--- a/paludis/repositories/portage/portage_repository_sets.cc
+++ b/paludis/repositories/portage/portage_repository_sets.cc
@@ -151,6 +151,11 @@ AdvisoryVisitor::visit(const BlockDepAtom *)
namespace paludis
{
+ /**
+ * Implementation data for PortageRepositorySets.
+ *
+ * \ingroup grpportagerepository
+ */
template<>
struct Implementation<PortageRepositorySets> :
InternalCounted<Implementation<PortageRepositorySets> >
diff --git a/paludis/repository.cc b/paludis/repository.cc
index bf46202..7a951e6 100644
--- a/paludis/repository.cc
+++ b/paludis/repository.cc
@@ -81,6 +81,11 @@ PackageUninstallActionError::PackageUninstallActionError(const std::string & msg
namespace paludis
{
+ /**
+ * Implementation data for RepositoryInfoSection.
+ *
+ * \ingroup grprepository
+ */
template<>
struct Implementation<RepositoryInfoSection> :
InternalCounted<Implementation<RepositoryInfoSection> >
@@ -89,6 +94,11 @@ namespace paludis
std::map<std::string, std::string> kvs;
};
+ /**
+ * Implementation data for RepositoryInfo.
+ *
+ * \ingroup grprepository
+ */
template<>
struct Implementation<RepositoryInfo> :
InternalCounted<Implementation<RepositoryInfo> >
diff --git a/paludis/util/dir_iterator.cc b/paludis/util/dir_iterator.cc
index e769334..423909e 100644
--- a/paludis/util/dir_iterator.cc
+++ b/paludis/util/dir_iterator.cc
@@ -34,6 +34,11 @@ using namespace paludis;
namespace paludis
{
+ /**
+ * Implementation data for DirIterator.
+ *
+ * \ingroup grpfilesystem
+ */
template<>
struct Implementation<DirIterator> :
InternalCounted<Implementation<DirIterator> >
diff --git a/paludis/util/fd_output_stream.hh b/paludis/util/fd_output_stream.hh
index 48babfe..acea1a2 100644
--- a/paludis/util/fd_output_stream.hh
+++ b/paludis/util/fd_output_stream.hh
@@ -58,10 +58,15 @@ namespace paludis
}
public:
+ ///\name Basic operations
+ ///\{
+
FDOutputStreamBuf(const int f) :
fd(f)
{
}
+
+ ///\}
};
/**
@@ -75,10 +80,15 @@ namespace paludis
FDOutputStreamBuf buf;
public:
+ ///\name Basic operations
+ ///\{
+
FDOutputStreamBase(const int fd) :
buf(fd)
{
}
+
+ ///\}
};
/**
@@ -91,11 +101,16 @@ namespace paludis
public std::ostream
{
public:
+ ///\name Basic operations
+ ///\{
+
FDOutputStream(const int fd) :
FDOutputStreamBase(fd),
std::ostream(&buf)
- {
- }
+ {
+ }
+
+ ///\}
};
}
diff --git a/paludis/util/pipe.hh b/paludis/util/pipe.hh
index 931dca8..89c2b2b 100644
--- a/paludis/util/pipe.hh
+++ b/paludis/util/pipe.hh
@@ -42,10 +42,18 @@ namespace paludis
int _fds[2];
public:
+ ///\name Basic operations
+ ///\{
+
Pipe();
~Pipe();
+ ///\}
+
+ ///\name File descriptors
+ ///\{
+
int read_fd() const
{
return _fds[0];
@@ -55,6 +63,8 @@ namespace paludis
{
return _fds[1];
}
+
+ ///\}
};
}