signal_base docs: Warn against deletion during emission

kjellahl · kjellahl · commit 82e7a7be938e · 2017-11-09T09:14:40.000+01:00
There is no known ABI-preserving fix for a memory leak, if a signal
is deleted during emission. Describe a workaround in the documentation.
Bug 167714
diff --git a/sigc++/signal_base.h b/sigc++/signal_base.h
@@ -297,6 +297,16 @@ struct temp_slot_list
  * incremented. Both sigc::signal# objects then refer to the same
  * sigc::internal::signal_impl object.
  *
+ * Deleting the signal during emission, e.g. from one of its slots, may result
+ * in memory leaks. This drawback is fixed in version 3 of libsigc++.
+ * A workaround is to make a copy of the signal during the emission:
+ * @code
+ * sigc::signal<...> sig2(*p_sig);
+ * p_sig->emit();
+ * @endcode
+ * This is not very costly. A sigc::signal<> is not much more than a pointer to
+ * a sigc::internal::signal_impl instance, which is not copied.
+ *
  * @ingroup signal
  */
 struct SIGC_API signal_base : public trackable
