docs: mem_fun: Improve the note about auto-disconnection.

murraycu · murraycu · commit 257acc28529f · 2016-04-01T12:00:16.000+02:00
Because "cleared" doesn't really tell us how this benefits us.
diff --git 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.

Original file line number	Diff line number	Diff line change
`@@ -217,9 +217,11 @@ namespace sigc {`
`217`	`217`	`*`
`218`	`218`	`* Optionally, a reference or pointer to an object can be bound to the functor.`
`219`	`219`	`*`
`220`		`- * @note Only if the object type inherits from sigc::trackable, and the`
`221`		`- * functor returned from mem_fun() is assigned to a sigc::slot, is the functor`
`222`		`- * automatically cleared when the object goes out of scope!`
	`220`	`+ * @note If the object type inherits from sigc::trackable, and the`
	`221`	`+ * functor returned from mem_fun() is assigned to a sigc::slot, the functor`
	`222`	`+ * will be automatically cleared when the object goes out of scope. Invoking`
	`223`	`+ * that slot will then have no effect and will not try to use the destroyed`
	`224`	`+ * instance.`
`223`	`225`	`*`
`224`	`226`	`* If the member function pointer is to an overloaded type, you must specify`
`225`	`227`	`* the types using template arguments starting with the first argument.`