r3922 - trunk/birnet

[timj svn gnome org]

Author: timj
Date: 2006-10-01 07:32:19 -0400 (Sun, 01 Oct 2006)
New Revision: 3922

Modified:
   trunk/birnet/ChangeLog
   trunk/birnet/birnetutilsxx.hh
Log:
Sun Oct  1 13:31:47 2006  Tim Janik  <timj gtk org>                                                                                                           
                                                                                                                                                              
        * birnetutilsxx.hh: added Deletable docs.                                                                                                             
                                                                                                                                                              



Modified: trunk/birnet/ChangeLog
===================================================================
--- trunk/birnet/ChangeLog	2006-09-30 19:38:45 UTC (rev 3921)
+++ trunk/birnet/ChangeLog	2006-10-01 11:32:19 UTC (rev 3922)
@@ -1,3 +1,7 @@
+Sun Oct  1 13:31:47 2006  Tim Janik  <timj gtk org>
+
+	* birnetutilsxx.hh: added Deletable docs.
+
 Sat Sep 30 18:00:13 2006  Tim Janik  <timj gtk org>
 
 	* birnetsignal.hh, birnetsignal.cc: moved virtual methods from .hh to

Modified: trunk/birnet/birnetutilsxx.hh
===================================================================
--- trunk/birnet/birnetutilsxx.hh	2006-09-30 19:38:45 UTC (rev 3921)
+++ trunk/birnet/birnetutilsxx.hh	2006-10-01 11:32:19 UTC (rev 3922)
@@ -113,7 +113,20 @@
 }
 
 /* --- Deletable --- */
+/**
+ * Deletable is a virtual base class that can be derived from (usually with
+ * public virtual) to ensure an object has a vtable and a virtual destructor.
+ * Also, it allows deletion hooks to be called during the objects destructor,
+ * by deriving from Birnet::Deletable::DeletionHook. No extra per-object space is
+ * consumed to allow deletion hooks, which makes Deletable a suitable base
+ * type for classes that may or may not need this feature (e.g. objects that
+ * can but often aren't used for signal handler connections).
+ */
 struct Deletable : public virtual VirtualTypeid {
+  /**
+   * DeletionHook is the base implementation class for hooks which are hooked
+   * up into the deletion phase of a Birnet::Deletable.
+   */
   class DeletionHook {
     DeletionHook    *prev;
     DeletionHook    *next;