aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-08-12 13:19:11 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-08-12 13:19:11 +0000
commit9e34f597072176ba2a59c4b3e8cd92af90c54807 (patch)
treed96a381d899456e27201e6ddefe4db762ca352d9
parent806d4b2912c3baf99aee7ca1241e262fd7e23dcb (diff)
downloadpaludis-9e34f597072176ba2a59c4b3e8cd92af90c54807.tar.gz
paludis-9e34f597072176ba2a59c4b3e8cd92af90c54807.tar.xz
More docs tweaks
-rw-r--r--doc/doc_main.doxygen10
-rw-r--r--paludis/dep_list_entry.sr9
-rw-r--r--paludis/ebin.sr27
-rw-r--r--paludis/ebuild.sr36
-rw-r--r--paludis/package_database_entry.sr10
-rw-r--r--paludis/qualified_package_name.sr8
-rw-r--r--paludis/repositories/cran/cran_installed_repository.sr10
-rw-r--r--paludis/repositories/cran/cran_repository.sr9
-rw-r--r--paludis/repositories/portage/portage_repository_params.sr9
-rw-r--r--paludis/repositories/vdb/vdb_repository.sr9
-rw-r--r--paludis/repository.sr27
-rw-r--r--paludis/repository_config_entry.sr10
-rw-r--r--paludis/syncer.sr9
-rw-r--r--paludis/use_config_entry.sr9
14 files changed, 192 insertions, 0 deletions
diff --git a/doc/doc_main.doxygen b/doc/doc_main.doxygen
index 7a4e070..daa8112 100644
--- a/doc/doc_main.doxygen
+++ b/doc/doc_main.doxygen
@@ -148,6 +148,16 @@
* \ingroup grprepository
*/
+/** \defgroup grpcranrepository CRAN repository
+ *
+ * \ingroup grprepository
+ */
+
+/** \defgroup grpcraninstrepository CRAN installed repository
+ *
+ * \ingroup grprepository
+ */
+
/** \defgroup grpebuildinterface Ebuild interface
*
* \ingroup grprepository
diff --git a/paludis/dep_list_entry.sr b/paludis/dep_list_entry.sr
index 9a58910..2dfeef2 100644
--- a/paludis/dep_list_entry.sr
+++ b/paludis/dep_list_entry.sr
@@ -10,6 +10,15 @@ make_class_DepListEntry()
key flags DepListEntryFlags
key tag "SortedCollection<DepTag::ConstPointer, DepTag::Comparator>::Pointer"
+ doxygen_comment << "END"
+ /**
+ * Holds a single entry in a DepList.
+ *
+ * \see DepList
+ * \ingroup grpdepresolver
+ */
+END
+
comparison_operators equality all
}
diff --git a/paludis/ebin.sr b/paludis/ebin.sr
index fd52440..267ca75 100644
--- a/paludis/ebin.sr
+++ b/paludis/ebin.sr
@@ -10,6 +10,15 @@ make_class_EbinCommandParams()
key pkgdir "FSEntry"
key buildroot "FSEntry"
+ doxygen_comment << "END"
+ /**
+ * Parameters for an EbinCommand.
+ *
+ * \see EbinCommand
+ * \ingroup grpebininterface
+ */
+END
+
allow_named_args
}
@@ -20,6 +29,15 @@ make_class_EbinFetchCommandParams()
key root std::string
key profiles FSEntryCollection::ConstPointer
+ doxygen_comment << "END"
+ /**
+ * Parameters for an EbinFetchCommand.
+ *
+ * \see EbinFetchCommand
+ * \ingroup grpebininterface
+ */
+END
+
allow_named_args
}
@@ -35,6 +53,15 @@ make_class_EbinInstallCommandParams()
key merge_only bool
key slot SlotName
+ doxygen_comment << "END"
+ /**
+ * Parameters for an EbinInstallCommand.
+ *
+ * \see EbinInstallCommand
+ * \ingroup grpebininterface
+ */
+END
+
allow_named_args
}
diff --git a/paludis/ebuild.sr b/paludis/ebuild.sr
index 8fd67da..9412957 100644
--- a/paludis/ebuild.sr
+++ b/paludis/ebuild.sr
@@ -12,6 +12,15 @@ make_class_EbuildCommandParams()
key distdir FSEntry
key buildroot FSEntry
+ doxygen_comment << "END"
+ /**
+ * Parameters for an EbuildCommand.
+ *
+ * \see EbuildCommand
+ * \ingroup grpebuildinterface
+ */
+END
+
allow_named_args
}
@@ -27,6 +36,15 @@ make_class_EbuildFetchCommandParams()
key expand_vars "AssociativeCollection<std::string, std::string>::ConstPointer"
key no_fetch bool
+ doxygen_comment << "END"
+ /**
+ * Parameters for an EbuildFetchCommand.
+ *
+ * \see EbuildFetchCommand
+ * \ingroup grpebuildinterface
+ */
+END
+
allow_named_args
}
@@ -43,6 +61,15 @@ make_class_EbuildInstallCommandParams()
key merge_only bool
key slot SlotName
+ doxygen_comment << "END"
+ /**
+ * Parameters for an EbuildInstallCommand.
+ *
+ * \see EbuildInstallCommand
+ * \ingroup grpebuildinterface
+ */
+END
+
allow_named_args
}
@@ -53,6 +80,15 @@ make_class_EbuildUninstallCommandParams()
key unmerge_only bool
key load_environment "const FSEntry *"
+ doxygen_comment << "END"
+ /**
+ * Parameters for an EbuildUninstallCommand.
+ *
+ * \see EbuildUninstallCommand
+ * \ingroup grpebuildinterface
+ */
+END
+
allow_named_args
}
diff --git a/paludis/package_database_entry.sr b/paludis/package_database_entry.sr
index 3057e8f..36f7edc 100644
--- a/paludis/package_database_entry.sr
+++ b/paludis/package_database_entry.sr
@@ -7,6 +7,16 @@ make_class_PackageDatabaseEntry()
key version VersionSpec
key repository RepositoryName
+ doxygen_comment << "END"
+ /**
+ * Holds an entry in a PackageDatabase, and used to identify a
+ * specific version of a package in a particular repository.
+ *
+ * \see PackageDatabase
+ * \ingroup grppackagedatabase
+ */
+END
+
comparison_operators all all
}
diff --git a/paludis/qualified_package_name.sr b/paludis/qualified_package_name.sr
index 13f0b8e..c271455 100644
--- a/paludis/qualified_package_name.sr
+++ b/paludis/qualified_package_name.sr
@@ -11,5 +11,13 @@ make_class_QualifiedPackageName()
extra_constructors <<END
QualifiedPackageName(const std::string &);
END
+
+ doxygen_comment << "END"
+ /**
+ * Represents a category plus package name.
+ *
+ * \ingroup grpnames
+ */
+END
}
diff --git a/paludis/repositories/cran/cran_installed_repository.sr b/paludis/repositories/cran/cran_installed_repository.sr
index e972866..48791bc 100644
--- a/paludis/repositories/cran/cran_installed_repository.sr
+++ b/paludis/repositories/cran/cran_installed_repository.sr
@@ -8,6 +8,16 @@ make_class_CRANInstalledRepositoryParams()
key location FSEntry
key root FSEntry
key world FSEntry
+
+ doxygen_comment << "END"
+ /**
+ * Parameters used to create a CRANInstalledRepository
+ *
+ * \see CRANInstalledRepository
+ * \ingroup grpcraninstrepository
+ */
+END
+
allow_named_args
}
diff --git a/paludis/repositories/cran/cran_repository.sr b/paludis/repositories/cran/cran_repository.sr
index c7b9615..fb4344d 100644
--- a/paludis/repositories/cran/cran_repository.sr
+++ b/paludis/repositories/cran/cran_repository.sr
@@ -13,6 +13,15 @@ make_class_CRANRepositoryParams()
key root FSEntry
key library FSEntry
+ doxygen_comment << "END"
+ /**
+ * Parameters used to create a CRANRepository
+ *
+ * \see CRANRepository
+ * \ingroup grpcranrepository
+ */
+END
+
allow_named_args
}
diff --git a/paludis/repositories/portage/portage_repository_params.sr b/paludis/repositories/portage/portage_repository_params.sr
index 54ece53..61d2044 100644
--- a/paludis/repositories/portage/portage_repository_params.sr
+++ b/paludis/repositories/portage/portage_repository_params.sr
@@ -20,6 +20,15 @@ make_class_PortageRepositoryParams()
key root FSEntry
key buildroot FSEntry
+ doxygen_comment << "END"
+ /**
+ * Parameters used to create a PortageRepository
+ *
+ * \see PortageRepository
+ * \ingroup grpportagerepository
+ */
+END
+
allow_named_args
}
diff --git a/paludis/repositories/vdb/vdb_repository.sr b/paludis/repositories/vdb/vdb_repository.sr
index 1441408..15a21ad 100644
--- a/paludis/repositories/vdb/vdb_repository.sr
+++ b/paludis/repositories/vdb/vdb_repository.sr
@@ -10,6 +10,15 @@ make_class_VDBRepositoryParams()
key world FSEntry
key buildroot FSEntry
+ doxygen_comment << "END"
+ /**
+ * Parameters used to create a VDBRepository
+ *
+ * \see VDBRepository
+ * \ingroup grpvdbrepository
+ */
+END
+
allow_named_args
}
diff --git a/paludis/repository.sr b/paludis/repository.sr
index 1a22e69..49e336f 100644
--- a/paludis/repository.sr
+++ b/paludis/repository.sr
@@ -5,11 +5,29 @@ make_class_InstallOptions()
{
key no_config_protect bool
key fetch_only bool
+
+ doxygen_comment << "END"
+ /**
+ * Options for the Repository::install method.
+ *
+ * \see Repository
+ * \ingroup grprepository
+ */
+END
}
make_class_PackageSetOptions()
{
key list_affected_only bool
+
+ doxygen_comment << "END"
+ /**
+ * Options for the Repository::package_set method.
+ *
+ * \see Repository
+ * \ingroup grprepository
+ */
+END
}
make_class_RepositoryCapabilities()
@@ -26,6 +44,15 @@ make_class_RepositoryCapabilities()
key mirrors_interface "RepositoryMirrorsInterface *"
key environment_variable_interface "RepositoryEnvironmentVariableInterface *"
+ doxygen_comment << "END"
+ /**
+ * Optional interfaces that may be provided by a Repository.
+ *
+ * \see Repository
+ * \ingroup grprepository
+ */
+END
+
allow_named_args
}
diff --git a/paludis/repository_config_entry.sr b/paludis/repository_config_entry.sr
index 648071b..2224f0e 100644
--- a/paludis/repository_config_entry.sr
+++ b/paludis/repository_config_entry.sr
@@ -6,6 +6,16 @@ make_class_RepositoryConfigEntry()
key format std::string
key importance unsigned
key keys "AssociativeCollection<std::string, std::string>::Pointer"
+
+ doxygen_comment << "END"
+ /**
+ * Represents a DefaultConfig repository config file.
+ *
+ * \see DefaultConfig
+ * \ingroup grpdefaultconfig
+ */
+END
+
comparison_operators all importance
}
diff --git a/paludis/syncer.sr b/paludis/syncer.sr
index 2d49fca..e3dcb88 100644
--- a/paludis/syncer.sr
+++ b/paludis/syncer.sr
@@ -4,5 +4,14 @@
make_class_SyncOptions()
{
key exclude_from std::string
+
+ doxygen_comment << "END"
+ /**
+ * Options used by Syncer.
+ *
+ * \see Syncer
+ * \ingroup grpsyncer
+ */
+END
}
diff --git a/paludis/use_config_entry.sr b/paludis/use_config_entry.sr
index 44dae8c..da77ea7 100644
--- a/paludis/use_config_entry.sr
+++ b/paludis/use_config_entry.sr
@@ -6,5 +6,14 @@ make_class_UseConfigEntry()
key dep_atom PackageDepAtom::ConstPointer
key flag_name UseFlagName
key flag_state UseFlagState
+
+ doxygen_comment << "END"
+ /**
+ * Represents a DefaultConfig package use configuration entry.
+ *
+ * \see DefaultConfig
+ * \ingroup grpdefaultconfig
+ */
+END
}