[glibmm] Regex: Slight documentation improvement.



commit a96fce281a705abc1b7fd60d4b174a4703a5f064
Author: Murray Cumming <murrayc murrayc com>
Date:   Mon Nov 23 08:26:46 2009 +0100

    Regex: Slight documentation improvement.
    
    * tools/m4/class_opaque_refcounted.m4: refererence()/unreference():
    Use the same doxygen comments as on ObjectBase::reference/unreference()
    so this shows up, for instance, on Glib::Regex.

 ChangeLog                           |    8 ++++++++
 tools/m4/class_opaque_refcounted.m4 |    8 +++++++-
 2 files changed, 15 insertions(+), 1 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index e6adc30..5208e86 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2009-11-23  Murray Cumming  <murrayc murrayc com>
+
+	Regex: Slight documentation improvement.
+
+	* tools/m4/class_opaque_refcounted.m4: refererence()/unreference():
+	Use the same doxygen comments as on ObjectBase::reference/unreference() 
+	so this shows up, for instance, on Glib::Regex.
+
 2009-10-22  Armin Burgmeier  <armin arbur net>
 
 	* MSVC_Net2005/giomm/giomm.vcproj:
diff --git a/tools/m4/class_opaque_refcounted.m4 b/tools/m4/class_opaque_refcounted.m4
index 3bc648b..3d2ebbf 100644
--- a/tools/m4/class_opaque_refcounted.m4
+++ b/tools/m4/class_opaque_refcounted.m4
@@ -147,8 +147,14 @@ ifelse(__OPAQUE_FUNC_NEW,NONE,`dnl
   static Glib::RefPtr<__CPPNAME__> create();
 ')dnl endif __OPAQUE_FUNC_NEW
 
-  // For use with Glib::RefPtr<> only.
+  /** Increment the reference count for this object.
+   * You should never need to do this manually - use the object via a RefPtr instead.
+   */
   void reference()   const;
+
+  /** Decrement the reference count for this object.
+   * You should never need to do this manually - use the object via a RefPtr instead.
+   */
   void unreference() const;
 
   ///Provides access to the underlying C instance.



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