[Boost-commit] svn:boost r53130 - trunk/libs/signals2/doc/reference

Subject: [Boost-commit] svn:boost r53130 - trunk/libs/signals2/doc/reference
From: fmhess_at_[hidden]
Date: 2009-05-20 10:51:20

Author: fmhess
Date: 2009-05-20 10:51:19 EDT (Wed, 20 May 2009)
New Revision: 53130
URL: http://svn.boost.org/trac/boost/changeset/53130

Log:
Added explicit documentation of shared_connection_block's default
copy constructor and assignment operator.

Text files modified: 
   trunk/libs/signals2/doc/reference/shared_connection_block.xml |    34 ++++++++++++++++++++++++++++++++--      
   1 files changed, 32 insertions(+), 2 deletions(-)

Modified: trunk/libs/signals2/doc/reference/shared_connection_block.xml
==============================================================================
--- trunk/libs/signals2/doc/reference/shared_connection_block.xml	(original)
+++ trunk/libs/signals2/doc/reference/shared_connection_block.xml	2009-05-20 10:51:19 EDT (Wed, 20 May 2009)
@@ -42,9 +42,9 @@
           </para>
         </description>
 
-      <constructor>
+        <constructor>
           <parameter name="conn">
-            <paramtype>const boost::signals2::connection &amp;</paramtype>
+            <paramtype>const <classname>boost::signals2::connection</classname> &amp;</paramtype>
             <default>connection()</default>
           </parameter>
           <parameter name="initially_blocking">
@@ -69,9 +69,39 @@
           </effects>
           <postconditions><para><code>this->blocking() == initially_blocking</code></para></postconditions>
         </constructor>
+        <constructor>
+          <parameter name="other">
+            <paramtype>const boost::signals2::shared_connection_block &amp;</paramtype>
+          </parameter>
+
+          <effects>
+            <para>
+              Copy constructs a <code>shared_connection_block</code> which references
+              the same connection as <code>other</code>.
+            </para>
+          </effects>
+          <postconditions>
+            <para><code>this->blocking() == other.blocking()</code></para>
+          </postconditions>
+        </constructor>
         <destructor>
           <effects><para>If <methodname>blocking</methodname>() is true, releases the connection block.</para></effects>
         </destructor>
+        <copy-assignment>
+          <parameter name="rhs">
+            <paramtype>const boost::signals2::shared_connection_block &amp;</paramtype>
+          </parameter>
+
+          <effects>
+            <para>
+              Makes <code>this</code> reference the same connection as <code>rhs</code>.
+            </para>
+          </effects>
+          <postconditions>
+            <para><code>this->blocking() == rhs.blocking()</code></para>
+          </postconditions>
+          <throws><para>Will not throw.</para></throws>
+        </copy-assignment>
         <method-group name="connection blocking">
           <method name="unblock">
             <type>void</type>