[Boost-commit] svn:boost r51152 - in sandbox/thread_safe_signals/trunk/libs/signals2/doc: . reference

Subject: [Boost-commit] svn:boost r51152 - in sandbox/thread_safe_signals/trunk/libs/signals2/doc: . reference
From: fmhess_at_[hidden]
Date: 2009-02-09 17:04:12

Author: fmhess
Date: 2009-02-09 17:04:11 EST (Mon, 09 Feb 2009)
New Revision: 51152
URL: http://svn.boost.org/trac/boost/changeset/51152

Log:
Some minor documentation tweaks.

Text files modified: 
   sandbox/thread_safe_signals/trunk/libs/signals2/doc/rationale.xml             |     6 +++---                                  
   sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/deconstruct.xml |     5 ++---                                   
   2 files changed, 5 insertions(+), 6 deletions(-)

Modified: sandbox/thread_safe_signals/trunk/libs/signals2/doc/rationale.xml
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/rationale.xml	(original)
+++ sandbox/thread_safe_signals/trunk/libs/signals2/doc/rationale.xml	2009-02-09 17:04:11 EST (Mon, 09 Feb 2009)
@@ -117,13 +117,13 @@
     <title><code>optional_last_value</code> as the Default Combiner</title>
     <para>
       The default combiner for Boost.Signals2 has changed from the <code>last_value</code>
-      combiner used as the default by the original Boost.Signals library.
+      combiner used by default in the original Boost.Signals library.
       This is because <code>last_value</code> requires that at least 1 slot be
-      connected to a signal when it is invoked (except for its void specialization).
+      connected to the signal when it is invoked (except for the <code>last_value&lt;void&gt;</code> specialization).
       In a multi-threaded environment where signal invocations and slot connections
       and disconnections may be happening concurrently, it is difficult
       to fulfill this requirement.  When using <classname>optional_last_value</classname>,
-      there is no requirement for any slots to be connected when a signal
+      there is no requirement for slots to be connected when a signal
       is invoked, since in that case the combiner may simply return an empty
       <classname>boost::optional</classname>.
     </para>

Modified: sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/deconstruct.xml
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/deconstruct.xml	(original)
+++ sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/deconstruct.xml	2009-02-09 17:04:11 EST (Mon, 09 Feb 2009)
@@ -109,9 +109,8 @@
             declaring <classname>deconstruct_access</classname> a friend.  Using private
             constructors in conjunction with <classname>deconstruct_access</classname>
             can be useful to
-            ensure <classname>postconstructible</classname> or <classname>predestructible</classname>
-            objects are always created
-            properly using <code>deconstruct</code>.
+            ensure your objects are only created by <code>deconstruct</code>, and thus
+            their postconstructors or predestructors will always be called.
           </para>
         </notes>
         <returns><para>A <code>postconstructor_invoker&lt;T&gt;</code> owning a newly allocated object of