summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKjell Ahlstedt <kjellahlstedt@gmail.com>2022-10-10 16:21:06 +0200
committerKjell Ahlstedt <kjellahlstedt@gmail.com>2022-10-10 16:21:06 +0200
commit8fc43b1154247681b9f69557033127859261168a (patch)
tree851ec23dc6dbd078e6ccf3a517f3ee3af74b49fb
parentd7cfb908cafc975e054dc97637dddd9d178e4f89 (diff)
downloadglibmm-8fc43b1154247681b9f69557033127859261168a.tar.gz
Glib::RefPtr: Put the documentation in a Doxygen group
A group (but not a 'using' alias) gets its own html file, which can be referred to from outside glibmm.
-rw-r--r--glib/glibmm/refptr.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/glib/glibmm/refptr.h b/glib/glibmm/refptr.h
index d2f5a667..2d084ca7 100644
--- a/glib/glibmm/refptr.h
+++ b/glib/glibmm/refptr.h
@@ -35,6 +35,15 @@ void RefPtrDeleter(T_CppObject* object)
}
#endif // DOXYGEN_SHOULD_SKIP_THIS
+// RefPtr is put in a group, because a group (but not a 'using' alias)
+// gets its own html file, which can be referred to from outside glibmm,
+// for instance from the gtkmm tutorial.
+// Without a group, Doxygen generates links to the 'using' alias such as
+// .../html/namespaceGlib.html#afa2fecfa732e9ec1107ace03a2911d63
+/** @defgroup RefPtr RefPtr
+ * A reference-counting shared smartpointer
+ */
+
/** RefPtr<> is a reference-counting shared smartpointer.
*
* Some objects in gtkmm are obtained from a shared
@@ -65,6 +74,8 @@ void RefPtrDeleter(T_CppObject* object)
*
* @see Glib::make_refptr_for_instance()
* if you need to implement a create() method for a %Glib::ObjectBase-derived class.
+ *
+ * @ingroup RefPtr
*/
template <class T_CppObject>
using RefPtr = std::shared_ptr<T_CppObject>;