[libsigcplusplus/libsigc++-2-10] docs: mem_fun: Improve the note about auto-disconnection.



commit 257acc28529f8dc693bfbd5784c1c86f4f19978a
Author: Murray Cumming <murrayc murrayc com>
Date:   Fri Apr 1 12:00:16 2016 +0200

    docs: mem_fun: Improve the note about auto-disconnection.
    
    Because "cleared" doesn't really tell us how this benefits us.

 sigc++/functors/macros/mem_fun.h.m4 |    8 +++++---
 1 files changed, 5 insertions(+), 3 deletions(-)
---
diff --git a/sigc++/functors/macros/mem_fun.h.m4 b/sigc++/functors/macros/mem_fun.h.m4
index 5e9b859..597496b 100644
--- a/sigc++/functors/macros/mem_fun.h.m4
+++ b/sigc++/functors/macros/mem_fun.h.m4
@@ -217,9 +217,11 @@ namespace sigc {
  *
  * Optionally, a reference or pointer to an object can be bound to the functor.
  *
- * @note Only if the object type inherits from sigc::trackable, and the
- * functor returned from mem_fun() is assigned to a sigc::slot, is the functor
- * automatically cleared when the object goes out of scope!
+ * @note If the object type inherits from sigc::trackable, and the
+ * functor returned from mem_fun() is assigned to a sigc::slot, the functor
+ * will be automatically cleared when the object goes out of scope. Invoking
+ * that slot will then have no effect and will not try to use the destroyed
+ * instance.
  *
  * If the member function pointer is to an overloaded type, you must specify
  * the types using template arguments starting with the first argument.


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