[glibmm] Glib::RefPtr: Put the documentation in a Doxygen group



commit 8fc43b1154247681b9f69557033127859261168a
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Mon Oct 10 16:21:06 2022 +0200

    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.

 glib/glibmm/refptr.h | 11 +++++++++++
 1 file changed, 11 insertions(+)
---
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>;


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]