diff options
| author | Murray Cumming <murrayc@usa.net> | 2003-12-14 11:53:04 +0000 |
|---|---|---|
| committer | Murray Cumming <murrayc@src.gnome.org> | 2003-12-14 11:53:04 +0000 |
| commit | 680431c60a1c979ae72a485893071ed30dce9b9f (patch) | |
| tree | 4e21fc61f94b4590230dc56514b556abb0f1f77d /tools/m4/class_gobject.m4 | |
| parent | 2fcca07da305b5dc38662b7768ca290b985e5552 (diff) | |
| download | glibmm-680431c60a1c979ae72a485893071ed30dce9b9f.tar.gz | |
Added fuller Doxygen documentation to all gobj() and wrap() methods.
2003-12-13 Murray Cumming <murrayc@usa.net>
* tools/m4/*.m4: Added fuller Doxygen documentation to all gobj() and
wrap() methods. Doxygen should not emit warnings about these now.
Diffstat (limited to 'tools/m4/class_gobject.m4')
| -rw-r--r-- | tools/m4/class_gobject.m4 | 7 |
1 files changed, 6 insertions, 1 deletions
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: |