Documented module "Safe widget deletion support functions"

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6575 ea41ed52-d2ee-0310-a9c1-e6b18d33e121

1 files changed, 13 insertions, 1 deletions

diff --git a/FL/Fl.H b/FL/Fl.H
index 5da8b2784..6ab8e114a 100644
--- a/FL/Fl.H
+++ b/FL/Fl.H
@@ -831,7 +831,19 @@ public:
   /** @} */
 
   /** \defgroup fl_del_widget Safe widget deletion support functions
-	fl multithreading support functions
+
+	These functions support deletion of widgets inside callbacks.
+
+	There are two groups of related methods:
+
+	  -# scheduled widget deletion
+	    - Fl::delete_widget() schedules widgets for deletion
+	    - Fl::do_widget_deletion() deletes all scheduled widgets
+	  -# widget watch list ("smart pointers")
+	    - Fl::watch_widget_pointer() adds a widget pointer to the watch list
+	    - Fl::release_widget_pointer() removes a widget pointer from the watch list
+	    - Fl::clear_widget_pointer() clears a widget pointer \e in the watch list
+
    @{ */
   // Widget deletion:
   static void delete_widget(Fl_Widget *w);