aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-02 14:50:36 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-02 14:50:36 +0000
commit69fa594051d412e9e7de0041085974a3188612c2 (patch)
tree0d260d2db5ee241bd99705842807f2a552c488a2
parentf40fbd963a32af568baf844d9555a4ca3bc2fc65 (diff)
downloadpaludis-69fa594051d412e9e7de0041085974a3188612c2.tar.gz
paludis-69fa594051d412e9e7de0041085974a3188612c2.tar.xz
More doxygen
-rw-r--r--doc/doc_main.doxygen12
-rw-r--r--doc/examples/Makefile.am6
-rw-r--r--doc/examples/example_action.cc2
-rw-r--r--paludis/contents.cc6
-rw-r--r--paludis/contents.hh4
-rw-r--r--paludis/dep_label-fwd.hh95
-rw-r--r--paludis/dep_label.cc1
-rw-r--r--paludis/dep_spec-fwd.hh6
8 files changed, 126 insertions, 6 deletions
diff --git a/doc/doc_main.doxygen b/doc/doc_main.doxygen
index 679ebee..d809d85 100644
--- a/doc/doc_main.doxygen
+++ b/doc/doc_main.doxygen
@@ -28,6 +28,18 @@
* - \ref example_action.cc "example_action.cc"
*/
+/** \defgroup g_contents Contents
+ *
+ * \ingroup g_paludis
+ *
+ * Contents heirarchies can be used to iterate over the content of an installed
+ * or binary package.
+ *
+ * \section Examples
+ *
+ * - \ref example_contents.cc "example_contents.cc"
+ */
+
/** \defgroup g_dep_spec Dependency specifications
*
* \ingroup g_paludis
diff --git a/doc/examples/Makefile.am b/doc/examples/Makefile.am
index 54bbba1..9b6e5ad 100644
--- a/doc/examples/Makefile.am
+++ b/doc/examples/Makefile.am
@@ -12,6 +12,7 @@ SUBDIRS = .
noinst_PROGRAMS = \
example_about \
example_action \
+ example_contents \
example_dep_label
EXTRA_DIST = $(noinst_SCRIPTS)
@@ -25,6 +26,11 @@ example_action_LDFLAGS = \
$(top_builddir)/paludis/libpaludis.la \
$(top_builddir)/paludis/environments/libpaludisenvironments.la
+example_contents_SOURCES = example_contents.cc
+example_contents_LDFLAGS = \
+ $(top_builddir)/paludis/libpaludis.la \
+ $(top_builddir)/paludis/environments/libpaludisenvironments.la
+
example_dep_label_SOURCES = example_dep_label.cc
example_dep_label_LDFLAGS = \
$(top_builddir)/paludis/libpaludis.la \
diff --git a/doc/examples/example_action.cc b/doc/examples/example_action.cc
index 4b852e6..bfbe87f 100644
--- a/doc/examples/example_action.cc
+++ b/doc/examples/example_action.cc
@@ -100,6 +100,8 @@ int main(int, char *[])
cout << endl;
}
}
+
+ cout << endl;
}
return exit_status;
diff --git a/paludis/contents.cc b/paludis/contents.cc
index 8d900d9..d81b2b8 100644
--- a/paludis/contents.cc
+++ b/paludis/contents.cc
@@ -23,12 +23,6 @@
#include <libwrapiter/libwrapiter_forward_iterator.hh>
#include <list>
-/** \file
- * Implementation for Contents classes.
- *
- * \ingroup grpcontents
- */
-
using namespace paludis;
template class ConstVisitor<ContentsVisitorTypes>;
diff --git a/paludis/contents.hh b/paludis/contents.hh
index 87fa028..dc33254 100644
--- a/paludis/contents.hh
+++ b/paludis/contents.hh
@@ -34,6 +34,10 @@
* Declarations for the Contents classes.
*
* \ingroup g_contents
+ *
+ * \section Examples
+ *
+ * - \ref example_contents.cc "example_contents.cc"
*/
namespace paludis
diff --git a/paludis/dep_label-fwd.hh b/paludis/dep_label-fwd.hh
index 1019e1b..2dc664b 100644
--- a/paludis/dep_label-fwd.hh
+++ b/paludis/dep_label-fwd.hh
@@ -58,30 +58,125 @@ namespace paludis
struct DependencyABIsLabel;
template <typename T_, typename Category_> struct ConcreteDependencyLabel;
+
+ /**
+ * A DependencyHostLabel specifies host requirements for building a package.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyHostLabelTag { },
DependencySystemLabel> DependencyHostLabel;
+
+ /**
+ * A DependencyTargetLabel specifies target requirements for building a package.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyTargetLabelTag { },
DependencySystemLabel> DependencyTargetLabel;
+
+ /**
+ * A DependencyBuildLabel specifies build-time requirements for building a package.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyBuildLabelTag { },
DependencyTypeLabel> DependencyBuildLabel;
+
+ /**
+ * A DependencyRunLabel specifies runtime requirements for building a package.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyRunLabelTag { },
DependencyTypeLabel> DependencyRunLabel;
+
+ /**
+ * A DependencyInstallLabel specifies install-time requirements for building a package.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyInstallLabelTag { },
DependencyTypeLabel> DependencyInstallLabel;
+
+ /**
+ * A DependencyCompileLabel specifies compiled-against requirements for building a package.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyCompileLabelTag { },
DependencyTypeLabel> DependencyCompileLabel;
+
+ /**
+ * A DependencySuggestLabel specifies that a dependency is suggested.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencySuggestedLabelTag { },
DependencySuggestLabel> DependencySuggestedLabel;
+
+ /**
+ * A DependencyRecommendedLabel specifies that a dependency is recommended.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyRecommendedLabelTag { },
DependencySuggestLabel> DependencyRecommendedLabel;
+
+ /**
+ * A DependencyRequiredLabel specifies that a dependency is required.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyRequiredLabelTag { },
DependencySuggestLabel> DependencyRequiredLabel;
+
+ /**
+ * A DependencyAnyLabel specifies that a dependency can be satisfied by
+ * any ABI.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyAnyLabelTag { },
DependencyABIsLabel> DependencyAnyLabel;
+
+ /**
+ * A DependencyMineLabel specifies that a dependency is satisfied by
+ * ABIs equal to those being used to create the depending package.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyMineLabelTag { },
DependencyABIsLabel> DependencyMineLabel;
+
+ /**
+ * A DependencyPrimaryLabel specifies that a dependency can be satisfied by
+ * the primary ABI.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyPrimaryLabelTag { },
DependencyABIsLabel> DependencyPrimaryLabel;
+
+ /**
+ * A DependencyABILabel specifies that a dependency can be satisfied by
+ * a named ABI.
+ *
+ * \ingroup g_dep_spec
+ * \since 0.26
+ */
typedef ConcreteDependencyLabel<enum DependencyABILabelTag { },
DependencyABIsLabel> DependencyABILabel;
diff --git a/paludis/dep_label.cc b/paludis/dep_label.cc
index 305c910..8562f6c 100644
--- a/paludis/dep_label.cc
+++ b/paludis/dep_label.cc
@@ -137,3 +137,4 @@ template class ConcreteDependencyLabel<DependencyAnyLabel::Tag, DependencyABIsLa
template class ConcreteDependencyLabel<DependencyMineLabel::Tag, DependencyABIsLabel>;
template class ConcreteDependencyLabel<DependencyPrimaryLabel::Tag, DependencyABIsLabel>;
template class ConcreteDependencyLabel<DependencyABILabel::Tag, DependencyABIsLabel>;
+
diff --git a/paludis/dep_spec-fwd.hh b/paludis/dep_spec-fwd.hh
index d762a7e..997f6ee 100644
--- a/paludis/dep_spec-fwd.hh
+++ b/paludis/dep_spec-fwd.hh
@@ -27,6 +27,12 @@
#include <paludis/util/attributes.hh>
#include <paludis/util/visitor.hh>
+/** \file
+ * Forward declarations for paludis/dep_spec.hh .
+ *
+ * \ingroup g_dep_spec
+ */
+
namespace paludis
{
class DepSpec;