aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-21 01:37:08 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2006-01-21 01:37:08 +0000
commit268b0c0d806516481023edb3ea60420b68a6e517 (patch)
treeb7ff2cb34444ab68db15a71f3657c48611a17986
parentfaa4ad7964031e99bbc6a94961fe8af08324a892 (diff)
downloadpaludis-268b0c0d806516481023edb3ea60420b68a6e517.tar.gz
paludis-268b0c0d806516481023edb3ea60420b68a6e517.tar.xz
Define the VirtualConstructor Doxygen group. Add the VirtualConstructor nested classes to it, since Doxygen doesn't treat ingroup recursively.
-rw-r--r--doc/doc_main.doxygen9
-rw-r--r--paludis/virtual_constructor.hh4
2 files changed, 13 insertions, 0 deletions
diff --git a/doc/doc_main.doxygen b/doc/doc_main.doxygen
index 2d649ca..04940e4 100644
--- a/doc/doc_main.doxygen
+++ b/doc/doc_main.doxygen
@@ -193,6 +193,15 @@
* \ingroup Utility
*/
+/** \defgroup VirtualConstructor Virtual constructors
+ * Visitor pattern.
+ *
+ * See the GoF book for how virtual constructors (called "Factory Methods" in
+ * GoF) work. See the test cases for how to use it.
+ *
+ * \ingroup Utility
+ */
+
/** \defgroup ConfigFile Configuration handling
* Configuration handling.
*
diff --git a/paludis/virtual_constructor.hh b/paludis/virtual_constructor.hh
index a3f1d17..816d9f3 100644
--- a/paludis/virtual_constructor.hh
+++ b/paludis/virtual_constructor.hh
@@ -52,6 +52,8 @@ namespace paludis
{
/**
* Internal use: provide handle_not_found.
+ *
+ * \ingroup VirtualConstructor
*/
template <typename KeyType_, typename ValueType_>
struct Parent
@@ -167,6 +169,8 @@ namespace paludis
/**
* An instance of this class registers a new maker with the
* specified key.
+ *
+ * \ingroup VirtualConstructor
*/
struct RegisterMaker
{