Boost logo

Boost-Commit :

From: fmhess_at_[hidden]
Date: 2007-09-26 10:01:39


Author: fmhess
Date: 2007-09-26 10:01:38 EDT (Wed, 26 Sep 2007)
New Revision: 39543
URL: http://svn.boost.org/trac/boost/changeset/39543

Log:
Fixed some unresolved cross references in the documentation.

Text files modified:
   sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/connection.xml | 2 +-
   sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/deconstruct_ptr.xml | 10 +++++++---
   sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/signal_header.xml | 4 ++--
   sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/slot.xml | 1 +
   sandbox/thread_safe_signals/libs/thread_safe_signals/doc/tests.xml | 2 +-
   sandbox/thread_safe_signals/libs/thread_safe_signals/doc/tutorial.xml | 10 +++++-----
   6 files changed, 17 insertions(+), 12 deletions(-)

Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/connection.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/connection.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/connection.xml 2007-09-26 10:01:38 EDT (Wed, 26 Sep 2007)
@@ -173,7 +173,7 @@
 
         <destructor>
           <effects><para>If
- <computeroutput>this-&gt;<methodname>connected</methodname>()</computeroutput>,
+ <computeroutput>this-&gt;<methodname alt="connection::connected">connected</methodname>()</computeroutput>,
           disconnects the signal-slot connection.</para></effects>
         </destructor>
 

Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/deconstruct_ptr.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/deconstruct_ptr.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/deconstruct_ptr.xml 2007-09-26 10:01:38 EDT (Wed, 26 Sep 2007)
@@ -42,9 +42,13 @@
         <type>void</type>
         <parameter name="pointer"><paramtype>const T *</paramtype>
         </parameter>
- <effects><para>Calls <code>pointer-><methodname>predestruct</methodname>()</code> if <code>T</code> is derived from
- <classname>predestructible</classname>. Then <code>pointer</code> is deleted using
- <functionname>checked_delete</functionname>.</para></effects>
+ <effects>
+ <para>Calls <code>pointer-><methodname alt="predestructible::predestruct">predestruct</methodname>()</code>
+ if <code>T</code> is derived from
+ <classname>predestructible</classname>. Then <code>pointer</code> is deleted using
+ <functionname>checked_delete</functionname>.
+ </para>
+ </effects>
       </method>
       <purpose>Predestruct object if it is predestructible, then delete.
       </purpose>

Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/signal_header.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/signal_header.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/signal_header.xml 2007-09-26 10:01:38 EDT (Wed, 26 Sep 2007)
@@ -277,10 +277,10 @@
           of parameters <computeroutput>(a1, a2, ...,
           aN)</computeroutput>, the result of which is returned from
           the iterator dereference operation. Note, dereferencing
- a slot iterator may throw a <classname>slot_expired</classname>
+ a slot iterator may throw a <classname>expired_slot</classname>
           exception, if the slot has been disconnected via automatic
           connection management. Combiners should simply swallow
- such <classname>slot_expired</classname> exceptions and move
+ such <classname>expired_slot</classname> exceptions and move
           on to the next slot.</para></effects>
 
           <returns><para>The result returned by the combiner.</para></returns>

Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/slot.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/slot.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/slot.xml 2007-09-26 10:01:38 EDT (Wed, 26 Sep 2007)
@@ -5,6 +5,7 @@
   <using-namespace name="boost"/>
   <using-namespace name="boost::signalslib"/>
   <using-class name="boost::signalN"/>
+ <using-class name="boost::signalslib::slot_base"/>
   <namespace name="boost">
     <class name="slotN">
       <template>

Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/tests.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/tests.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/tests.xml 2007-09-26 10:01:38 EDT (Wed, 26 Sep 2007)
@@ -6,7 +6,7 @@
     <lib>../../../libs/test/build/boost_test_exec_monitor</lib>
     <lib>../build/boost_signals</lib>
     <purpose>
-<para>Ensure that calling <methodname>connect</methodname> with a slot
+<para>Ensure that calling <methodname alt="boost::signalN::connect">connect</methodname> with a slot
 that has already expired does not actually
 connect to the slot.</para>
     </purpose>

Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/tutorial.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/tutorial.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/tutorial.xml 2007-09-26 10:01:38 EDT (Wed, 26 Sep 2007)
@@ -679,13 +679,13 @@
 connection still exists or to disconnect the signal and slot.</para>
 <programlisting>
 boost::signalslib::connection c = sig.<methodname>connect</methodname>(HelloWorld());
-if (c.<methodname>connected</methodname>()) {
+if (c.<methodname alt="connection::connected">connected</methodname>()) {
 <emphasis>// c is still connected to the signal</emphasis>
   sig(); <emphasis>// Prints "Hello, World!"</emphasis>
 }
 
-c.disconnect(); <emphasis>// Disconnect the HelloWorld object</emphasis>
-assert(!c.<methodname>connected</methodname>()); <emphasis>c isn't connected any more</emphasis>
+c.<methodname alt="connection::disconnect">disconnect</methodname>(); <emphasis>// Disconnect the HelloWorld object</emphasis>
+assert(!c.<methodname alt="connection::connected">connected</methodname>()); <emphasis>// c isn't connected any more</emphasis>
 
 sig(); <emphasis>// Does nothing: there are no connected slots</emphasis>
 </programlisting>
@@ -710,7 +710,7 @@
 
 {
   boost::signalslib::shared_connection_block block(c); <emphasis>// block the slot</emphasis>
- assert(c.<methodname>blocked</methodname>());
+ assert(c.<methodname alt="connection::blocked">blocked</methodname>());
   sig(); <emphasis>// No output: the slot is blocked</emphasis>
 } <emphasis>// shared_connection_block going out of scope unblocks the slot</emphasis>
 sig(); <emphasis>// Prints "Hello, World!"</emphasis>
@@ -1144,7 +1144,7 @@
 <section>
   <title>Linking against the Signals library</title>
   <para>The thread_safe_signals version of Boost.Signals is currently a header-only library.
- However, if you use the <classname>boost::signalslib::multithreaded</classname> class as
+ However, if you use the <classname>boost::signalslib::multi_threaded</classname> class as
   the ThreadingModel template parameter for your signals, you will have to link to the
   Boost.threads library, libboost_thread.
   .


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk