aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-04-18 23:09:14 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-04-18 23:09:14 +0000
commite3e572a7fa82cd33fa1dfb282426146afc483ae4 (patch)
treec5c0d81c45fe047c6b3d324978bd0ad1988196aa
parentb12733d16f6896790c3763fbdd47c4c3619da927 (diff)
downloadpaludis-e3e572a7fa82cd33fa1dfb282426146afc483ae4.tar.gz
paludis-e3e572a7fa82cd33fa1dfb282426146afc483ae4.tar.xz
More doxygen
-rw-r--r--doc/doc_main.doxygen58
-rw-r--r--doc/doc_mainpage.doxygen3
-rw-r--r--paludis/config_file.se2
-rw-r--r--paludis/host_tuple_name.hh8
4 files changed, 61 insertions, 10 deletions
diff --git a/doc/doc_main.doxygen b/doc/doc_main.doxygen
index 9f18927..82cef4d 100644
--- a/doc/doc_main.doxygen
+++ b/doc/doc_main.doxygen
@@ -73,11 +73,31 @@
* \ingroup grplibpaludis
*/
+/** \defgroup grphooker Hooker
+ *
+ * \ingroup grplibpaludis
+ */
+
+/** \defgroup grpmerger Merger
+ *
+ * \ingroup grplibpaludis
+ */
+
+/** \defgroup grpunmerger Unmerger
+ *
+ * \ingroup grplibpaludis
+ */
+
/** \defgroup grpnames Names
*
* \ingroup grplibpaludis
*/
+/** \defgroup grphosttuplename Host tuple names
+ *
+ * \ingroup grplibpaludis
+ */
+
/** \defgroup grpversions Versions
*
* \ingroup grplibpaludis
@@ -110,9 +130,19 @@
* \ingroup grpconfigfile
*/
+/** \defgroup grpsetfile Set files
+ *
+ * \ingroup grpconfigfile
+ */
+
// ----- grpenvironment Subgroups -----
-/** \defgroup grpdefaultenvironment Default environment
+/** \defgroup grppaludisenvironment Paludis environment
+ *
+ * \ingroup grpenvironment
+ */
+
+/** \defgroup grpporgateenvironment Portage environment
*
* \ingroup grpenvironment
*/
@@ -137,11 +167,11 @@
* \ingroup grpenvironment
*/
-// ----- grpdefaultenvironment Subgroups -----
+// ----- grppaludisenvironment Subgroups -----
-/** \defgroup grpdefaultconfig Default configuration
+/** \defgroup grppaludisconfig Paludis environment configuration
*
- * \ingroup grpdefaultenvironment
+ * \ingroup grppaludisenvironment
*/
// --- grppackagedatabase Subgroups -----
@@ -151,6 +181,11 @@
* \ingroup grppackagedatabase
*/
+/** \defgroup grpquery Queries
+ *
+ * \ingroup grppackagedatabase
+ */
+
// --- grprepository Subgroups -----
/** \defgroup grpfakerepository Fake repository
@@ -158,6 +193,11 @@
* \ingroup grprepository
*/
+/** \defgroup grpgemsrepository Gems repository
+ *
+ * \ingroup grprepository
+ */
+
/** \defgroup grpportagerepository Portage repository
*
* \ingroup grprepository
@@ -276,6 +316,11 @@
* \ingroup grplibpaludisutil
*/
+/** \defgroup grpgraph Graphs
+ *
+ * \ingroup grplibpaludisutil
+ */
+
/** \defgroup grpiterators Iterators
*
* \ingroup grplibpaludisutil
@@ -286,6 +331,11 @@
* \ingroup grplibpaludisutil
*/
+/** \defgroup grpnamedarguments Named arguments
+ *
+ * \ingroup grplibpaludisutil
+ */
+
/** \defgroup grppatterns Patterns
*
* \ingroup grplibpaludisutil
diff --git a/doc/doc_mainpage.doxygen b/doc/doc_mainpage.doxygen
index 38eba19..95fc6b7 100644
--- a/doc/doc_mainpage.doxygen
+++ b/doc/doc_mainpage.doxygen
@@ -11,8 +11,9 @@ than the full class lists.
Some classes you may find useful:
-- paludis::Environment
+- paludis::Environment, which is usually created using paludis::EnvironmentMaker
- paludis::PackageDatabase
- paludis::Repository and the associated interface classes
+- paludis::VersionMetadata
*/
diff --git a/paludis/config_file.se b/paludis/config_file.se
index e997777..bd8af06 100644
--- a/paludis/config_file.se
+++ b/paludis/config_file.se
@@ -41,7 +41,7 @@ make_enum_KeyValueConfigFileOption()
*
* \see KeyValueConfigFile
* \see KeyValueConfigFileOptions
- * \ingroup grpkeyvalueconfigfile
+ * \ingroup grpkvconfigfile
*/
END
}
diff --git a/paludis/host_tuple_name.hh b/paludis/host_tuple_name.hh
index 41e3027..0acd840 100644
--- a/paludis/host_tuple_name.hh
+++ b/paludis/host_tuple_name.hh
@@ -81,7 +81,7 @@ namespace paludis
* of an ArchitectureNamePart.
*
* \ingroup grpnames
- * \ingroup hosttuplename
+ * \ingroup grphosttuplename
*/
struct ArchitectureNamePartValidator :
private InstantiationPolicy<ArchitectureNamePartValidator, instantiation_method::NonInstantiableTag>
@@ -124,7 +124,7 @@ namespace paludis
* of an ManufacturerNamePart.
*
* \ingroup grpnames
- * \ingroup hosttuplename
+ * \ingroup grphosttuplename
*/
struct ManufacturerNamePartValidator :
private InstantiationPolicy<ManufacturerNamePartValidator, instantiation_method::NonInstantiableTag>
@@ -167,7 +167,7 @@ namespace paludis
* of an KernelNamePart.
*
* \ingroup grpnames
- * \ingroup hosttuplename
+ * \ingroup grphosttuplename
*/
struct KernelNamePartValidator :
private InstantiationPolicy<KernelNamePartValidator, instantiation_method::NonInstantiableTag>
@@ -210,7 +210,7 @@ namespace paludis
* of an UserlandNamePart.
*
* \ingroup grpnames
- * \ingroup hosttuplename
+ * \ingroup grphosttuplename
*/
struct UserlandNamePartValidator :
private InstantiationPolicy<UserlandNamePartValidator, instantiation_method::NonInstantiableTag>