From 680431c60a1c979ae72a485893071ed30dce9b9f Mon Sep 17 00:00:00 2001 From: Murray Cumming Date: Sun, 14 Dec 2003 11:53:04 +0000 Subject: Added fuller Doxygen documentation to all gobj() and wrap() methods. 2003-12-13 Murray Cumming * tools/m4/*.m4: Added fuller Doxygen documentation to all gobj() and wrap() methods. Doxygen should not emit warnings about these now. --- tools/m4/class_gobject.m4 | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'tools/m4/class_gobject.m4') diff --git a/tools/m4/class_gobject.m4 b/tools/m4/class_gobject.m4 index 8474cdb6..5f0c56e5 100644 --- a/tools/m4/class_gobject.m4 +++ b/tools/m4/class_gobject.m4 @@ -84,7 +84,11 @@ ifdef(`__BOOL_NO_WRAP_FUNCTION__',`dnl ',`dnl namespace Glib { - /** @relates __NAMESPACE__::__CPPNAME__ */ + /** @relates __NAMESPACE__::__CPPNAME__ + * @param object The C instance + * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref. + * @result A C++ instance that wraps this C instance. + */ Glib::RefPtr<__NAMESPACE__::__CPPNAME__> wrap(__REAL_CNAME__`'* object, bool take_copy = false); } ')dnl @@ -211,6 +215,7 @@ public: ///Provides access to the underlying C GObject. const __CNAME__* gobj() const { return reinterpret_cast<__CNAME__*>(gobject_); } + ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. __CNAME__* gobj_copy(); private: -- cgit v1.2.1