aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-10-24 10:31:09 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-10-24 10:31:09 +0000
commitdbd55319e24cd67540f33486e675bd88df4deaa8 (patch)
treec466bdb797ce128309416fe048c0957d982970ec
parentbb972990af73df1029479745a51b264315cb5824 (diff)
downloadpaludis-dbd55319e24cd67540f33486e675bd88df4deaa8.tar.gz
paludis-dbd55319e24cd67540f33486e675bd88df4deaa8.tar.xz
More doxygen tweaks
-rw-r--r--paludis/Makefile.am.m42
-rw-r--r--paludis/dep_tag.sr12
-rw-r--r--paludis/environment/no_config/Makefile.am1
-rw-r--r--paludis/qa/Makefile.am.m42
-rw-r--r--paludis/qa/message.sr8
-rw-r--r--paludis/version_metadata.sr54
6 files changed, 79 insertions, 0 deletions
diff --git a/paludis/Makefile.am.m4 b/paludis/Makefile.am.m4
index 071138e..ee057f9 100644
--- a/paludis/Makefile.am.m4
+++ b/paludis/Makefile.am.m4
@@ -98,3 +98,5 @@ comparison_policy.hh : comparison_policy.hh.m4
ihateautomake.cc : all
test -f $@ || touch $@
+built-sources : $(BUILT_SOURCES)
+
diff --git a/paludis/dep_tag.sr b/paludis/dep_tag.sr
index 2dfd21b..4f322cd 100644
--- a/paludis/dep_tag.sr
+++ b/paludis/dep_tag.sr
@@ -5,6 +5,18 @@ make_class_DepTagEntry()
allow_named_args
comparison_operators "all" "*tag"
+
+ doxygen_comment << "END"
+ /**
+ * Tags associated with a DepListEntry.
+ *
+ * The generation key is used internally by DepList. Its value is of no interest
+ * to outside clients.
+ *
+ * \see DepListEntry
+ * \ingroup grpdepresolver
+ */
+END
}
diff --git a/paludis/environment/no_config/Makefile.am b/paludis/environment/no_config/Makefile.am
index ac081cc..1d836de 100644
--- a/paludis/environment/no_config/Makefile.am
+++ b/paludis/environment/no_config/Makefile.am
@@ -39,4 +39,5 @@ no_config_environment-sr.hh : no_config_environment.sr $(top_srcdir)/misc/make_s
no_config_environment-sr.cc : no_config_environment.sr $(top_srcdir)/misc/make_sr.bash
$(top_srcdir)/misc/make_sr.bash --source $(srcdir)/no_config_environment.sr > $@
+built-sources : $(BUILT_SOURCES)
diff --git a/paludis/qa/Makefile.am.m4 b/paludis/qa/Makefile.am.m4
index 705a268..e28fd3f 100644
--- a/paludis/qa/Makefile.am.m4
+++ b/paludis/qa/Makefile.am.m4
@@ -98,3 +98,5 @@ DEFS= \
-DBIGTEMPDIR=\"/var/tmp\"
EXTRA_DIST = Makefile.am.m4 files.m4 qa.hh.m4 testscriptlist srlist srcleanlist
+built-sources : $(BUILT_SOURCES)
+
diff --git a/paludis/qa/message.sr b/paludis/qa/message.sr
index e4f559e..e9a3a0d 100644
--- a/paludis/qa/message.sr
+++ b/paludis/qa/message.sr
@@ -5,5 +5,13 @@ make_class_Message()
{
key level QALevel
key msg std::string
+
+ doxygen_comment << "END"
+ /**
+ * A QA message.
+ *
+ * \ingroup grpqa
+ */
+END
}
diff --git a/paludis/version_metadata.sr b/paludis/version_metadata.sr
index 1a11ad0..87e3a74 100644
--- a/paludis/version_metadata.sr
+++ b/paludis/version_metadata.sr
@@ -28,6 +28,15 @@ END
*/
DepAtom::ConstPointer post_depend() const;
END
+
+ doxygen_comment << "END"
+ /**
+ * Dependency data for VersionMetadata.
+ *
+ * \see VersionMetadata
+ * \ingroup grpversions
+ */
+END
}
make_class_VersionMetadataBase()
@@ -40,6 +49,15 @@ make_class_VersionMetadataBase()
key description std::string
allow_named_args
+
+ doxygen_comment << "END"
+ /**
+ * Version metadata common to all VersionMetadata types.
+ *
+ * \see VersionMetadata
+ * \ingroup grpversions
+ */
+END
}
make_class_EbuildVersionMetadata()
@@ -64,6 +82,15 @@ END
END
allow_named_args
+
+ doxygen_comment << "END"
+ /**
+ * Version metadata for ebuilds.
+ *
+ * \see VersionMetadata
+ * \ingroup grpversions
+ */
+END
}
make_class_CRANVersionMetadata()
@@ -74,6 +101,15 @@ make_class_CRANVersionMetadata()
key is_bundle bool
allow_named_args
+
+ doxygen_comment << "END"
+ /**
+ * Version metadata for CRAN packages.
+ *
+ * \see VersionMetadata
+ * \ingroup grpversions
+ */
+END
}
make_class_EbinVersionMetadata()
@@ -84,10 +120,28 @@ make_class_EbinVersionMetadata()
extra_constructors <<END
EbinVersionMetadata();
END
+
+ doxygen_comment << "END"
+ /**
+ * Version metadata for ebin packages.
+ *
+ * \see VersionMetadata
+ * \ingroup grpversions
+ */
+END
}
make_class_VirtualMetadata()
{
key virtual_for PackageDatabaseEntry
+
+ doxygen_comment << "END"
+ /**
+ * Version metadata for virtual packages.
+ *
+ * \see VersionMetadata
+ * \ingroup grpversions
+ */
+END
}