|
|
Boost-Commit : |
From: fmhess_at_[hidden]
Date: 2007-09-21 16:32:52
Author: fmhess
Date: 2007-09-21 16:32:50 EDT (Fri, 21 Sep 2007)
New Revision: 39459
URL: http://svn.boost.org/trac/boost/changeset/39459
Log:
Minor documentation improvements. Documented
boost::signalslib as the "official" namespace used by
thread_safe_signals.
Text files modified:
sandbox/thread_safe_signals/libs/thread_safe_signals/doc/introduction.xml | 4 ++++
sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/auto_threaded.xml | 8 ++++----
sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/connection.xml | 8 +++++++-
sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/multi_threaded.xml | 4 ++--
sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/shared_connection_block.xml | 10 +++++-----
sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/signal_header.xml | 20 ++++++++++----------
sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/single_threaded.xml | 4 ++--
sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/slot.xml | 4 ++--
sandbox/thread_safe_signals/libs/thread_safe_signals/doc/tutorial.xml | 32 ++++++++++++++++----------------
9 files changed, 52 insertions(+), 42 deletions(-)
Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/introduction.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/introduction.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/introduction.xml 2007-09-21 16:32:50 EDT (Fri, 21 Sep 2007)
@@ -46,5 +46,9 @@
browsed online</ulink> or checked out with the following command:
<programlisting>svn co http://svn.boost.org/svn/boost/sandbox/thread_safe_signals thread_safe_signals</programlisting>
</para>
+ <para>
+ The current version of this document should be available
+ <ulink url="http://www.comedi.org/projects/thread_safe_signals/libs/thread_safe_signals/doc/html/index.html">online</ulink>.
+ </para>
</section>
</section>
\ No newline at end of file
Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/auto_threaded.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/auto_threaded.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/auto_threaded.xml 2007-09-21 16:32:50 EDT (Fri, 21 Sep 2007)
@@ -3,9 +3,9 @@
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<header name="boost/signals/auto_threaded.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
<using-namespace name="boost"/>
- <using-namespace name="boost::signals"/>
+ <using-namespace name="boost::signalslib"/>
<namespace name="boost">
- <namespace name="signals">
+ <namespace name="signalslib">
<class name="auto_threaded">
<purpose>Automatically enabled/disabled thread-safety for a signal.</purpose>
@@ -21,12 +21,12 @@
<para>When in thread-safe mode, the <code>auto_threaded</code> class uses a
header-only mutex implementation. Thus, it has no dependence on the boost.threads
library. If you are already using boost.threads, you may prefer to use the
- <classname>boost::signals::multi_threaded</classname> <code>ThreadingModel</code>, which uses a
+ <classname>boost::signalslib::multi_threaded</classname> <code>ThreadingModel</code>, which uses a
mutex class provided by boost.threads.
</para>
<para>You may wish to use a thread-unsafe signal in a multi-threaded program, if
the signal is only used by a single thread. In that case, you may prefer to
- use the <classname>boost::signals::single_threaded</classname> class as your <code>ThreadingModel</code>.
+ use the <classname>boost::signalslib::single_threaded</classname> class as your <code>ThreadingModel</code>.
</para>
</description>
</class>
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-21 16:32:50 EDT (Fri, 21 Sep 2007)
@@ -3,7 +3,7 @@
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<header name="boost/signals/connection.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
<namespace name="boost">
- <namespace name="signals">
+ <namespace name="signalslib">
<class name="connection">
<!-- Models LessThanComparable and EqualityComparable -->
<purpose>Query/disconnect a signal-slot connection.</purpose>
@@ -72,6 +72,12 @@
<method-group name="blocking">
<method name="blocked" cv="const">
<type>bool</type>
+ <description>
+ <para>
+ Queries if the connection is blocked. A connection may be blocked by creating a
+ <classname>boost::signalslib::shared_connection_block</classname> object.
+ </para>
+ </description>
<returns><simpara><code>true</code> if the associated slot is either disconnected or blocked, <code>false</code> otherwise.</simpara></returns>
<throws><simpara>Will not throw.</simpara></throws>
</method>
Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/multi_threaded.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/multi_threaded.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/multi_threaded.xml 2007-09-21 16:32:50 EDT (Fri, 21 Sep 2007)
@@ -3,9 +3,9 @@
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<header name="boost/signals/multi_threaded.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
<using-namespace name="boost"/>
- <using-namespace name="boost::signals"/>
+ <using-namespace name="boost::signalslib"/>
<namespace name="boost">
- <namespace name="signals">
+ <namespace name="signalslib">
<class name="multi_threaded">
<purpose>Thread-safety for a signal, using Boost.Threads.</purpose>
Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/shared_connection_block.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/shared_connection_block.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/shared_connection_block.xml 2007-09-21 16:32:50 EDT (Fri, 21 Sep 2007)
@@ -3,10 +3,10 @@
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<header name="boost/signals/shared_connection_block.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
<using-namespace name="boost"/>
- <using-namespace name="boost::signals"/>
- <using-class name="boost::signals::connection"/>
+ <using-namespace name="boost::signalslib"/>
+ <using-class name="boost::signalslib::connection"/>
<namespace name="boost">
- <namespace name="signals">
+ <namespace name="signalslib">
<class name="shared_connection_block">
<purpose>Blocks a connection between a signal and a slot.</purpose>
@@ -27,7 +27,7 @@
<constructor>
<parameter name="conn">
- <paramtype>boost::signals::connection &</paramtype>
+ <paramtype>boost::signalslib::connection &</paramtype>
</parameter>
<effects>
@@ -62,7 +62,7 @@
<notes><para><code>this->blocking() == true</code> implies <code><methodname>connection::blocked</methodname>() == true</code>
for the connection. However, <code>this->blocking() == false</code> does not necessarily imply
<code>connection::blocked() == false</code>, since the connection may be
- blocked by another <code>shared_connection_block</code> objects.</para></notes>
+ blocked by another <code>shared_connection_block</code> object.</para></notes>
</method>
</method-group>
</class>
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-21 16:32:50 EDT (Fri, 21 Sep 2007)
@@ -3,7 +3,7 @@
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<header name="boost/signal.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
<namespace name="boost">
- <namespace name="signals">
+ <namespace name="signalslib">
<enum name="connect_position">
<enumvalue name="at_front"/>
<enumvalue name="at_back"/>
@@ -29,7 +29,7 @@
<default><classname>functionN</classname><R, T1, T2, ..., TN></default>
</template-type-parameter>
<template-type-parameter name="ThreadingModel">
- <default><classname>signals::auto_threaded</classname></default>
+ <default><classname>signalslib::auto_threaded</classname></default>
</template-type-parameter>
</template>
<inherit access="private">
@@ -109,18 +109,18 @@
<method-group name="connection management">
<overloaded-method name="connect">
<signature>
- <type><classname>signals::connection</classname></type>
+ <type><classname>signalslib::connection</classname></type>
<parameter name="slot">
<paramtype>const slot_type&</paramtype>
</parameter>
<parameter name="at">
- <paramtype>signals::connect_position</paramtype>
- <default>signals::at_back</default>
+ <paramtype>signalslib::connect_position</paramtype>
+ <default>signalslib::at_back</default>
</parameter>
</signature>
<signature>
- <type><classname>signals::connection</classname></type>
+ <type><classname>signalslib::connection</classname></type>
<parameter name="group">
<paramtype>const group_type&</paramtype>
</parameter>
@@ -128,8 +128,8 @@
<paramtype>const slot_type&</paramtype>
</parameter>
<parameter name="at">
- <paramtype>signals::connect_position</paramtype>
- <default>signals::at_back</default>
+ <paramtype>signalslib::connect_position</paramtype>
+ <default>signalslib::at_back</default>
</parameter>
</signature>
@@ -147,7 +147,7 @@
slots.</simpara></effects>
<returns><simpara>A
- <computeroutput><classname>signals::connection</classname></computeroutput>
+ <computeroutput><classname>signalslib::connection</classname></computeroutput>
object that references the newly-created connection between
the signal and the slot; if the slot is inactive, returns a
disconnected connection.</simpara></returns>
@@ -344,7 +344,7 @@
<default><classname>function</classname><Signature></default>
</template-type-parameter>
<template-type-parameter name="ThreadingModel">
- <default><classname>signals::auto_threaded</classname></default>
+ <default><classname>signalslib::auto_threaded</classname></default>
</template-type-parameter>
</template>
Modified: sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/single_threaded.xml
==============================================================================
--- sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/single_threaded.xml (original)
+++ sandbox/thread_safe_signals/libs/thread_safe_signals/doc/reference/single_threaded.xml 2007-09-21 16:32:50 EDT (Fri, 21 Sep 2007)
@@ -3,9 +3,9 @@
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<header name="boost/signals/single_threaded.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
<using-namespace name="boost"/>
- <using-namespace name="boost::signals"/>
+ <using-namespace name="boost::signalslib"/>
<namespace name="boost">
- <namespace name="signals">
+ <namespace name="signalslib">
<class name="single_threaded">
<purpose>Single-threaded choice for the ThreadingModel template parameter of a signal.</purpose>
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-21 16:32:50 EDT (Fri, 21 Sep 2007)
@@ -3,7 +3,7 @@
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<header name="boost/signals/slot.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
<using-namespace name="boost"/>
- <using-namespace name="boost::signals"/>
+ <using-namespace name="boost::signalslib"/>
<using-class name="boost::signalN"/>
<namespace name="boost">
<class name="slotN">
@@ -192,7 +192,7 @@
<signature>
<type>slotN &</type>
<parameter name="tracked_slot">
- <paramtype>const signals::detail::slot_base &</paramtype>
+ <paramtype>const signalslib::detail::slot_base &</paramtype>
</parameter>
</signature>
<effects><para>Adds object(s) to the slot's tracked object list. Should any of the
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-21 16:32:50 EDT (Fri, 21 Sep 2007)
@@ -5,7 +5,7 @@
<title>Tutorial</title>
<using-namespace name="boost"/>
- <using-namespace name="boost::signals"/>
+ <using-namespace name="boost::signalslib"/>
<using-class name="boost::signalN"/>
<using-class name="boost::slotN"/>
@@ -276,7 +276,7 @@
group parameter and those that don't? The "unnamed" slots (i.e., those
that have been connected without specifying a group name) can be
placed at the front or back of the slot list (by passing
-<code>boost::signals::at_front</code> or <code>boost::signals::at_back</code>
+<code>boost::signalslib::at_front</code> or <code>boost::signalslib::at_back</code>
as the last parameter to <code><methodname
alt="boost::signalN::connect">connect</methodname></code>, respectively), and defaults to the end of the list. When
a group is specified, the final parameter describes where the slot
@@ -649,12 +649,12 @@
<section><title>Connection Management</title>
<section><title>Disconnecting Slots (Beginner)</title>
-<para>Slots aren't expected to exist indefinately after they are
+<para>Slots aren't expected to exist indefinitely after they are
connected. Often slots are only used to receive a few events and
are then disconnected, and the programmer needs control to decide
when a slot should no longer be connected.</para>
<para>The entry point for managing connections explicitly is the
-<code><classname>boost::signals::connection</classname></code> class. The
+<code><classname>boost::signalslib::connection</classname></code> class. The
<code><classname>connection</classname></code> class uniquely represents the connection
between a particular signal and a particular slot. The
<code><methodname alt="connection::connected">connected</methodname>()</code> method checks if the signal and slot are
@@ -664,7 +664,7 @@
returns a connection object, which can be used to determine if the
connection still exists or to disconnect the signal and slot.</para>
<programlisting>
-boost::signals::connection c = sig.<methodname>connect</methodname>(HelloWorld());
+boost::signalslib::connection c = sig.<methodname>connect</methodname>(HelloWorld());
if (c.<methodname>connected</methodname>()) {
<emphasis>// c is still connected to the signal</emphasis>
sig(); <emphasis>// Prints "Hello, World!"</emphasis>
@@ -681,7 +681,7 @@
<para>Slots can be temporarily "blocked", meaning that they will be
ignored when the signal is invoked but have not been disconnected. A
-<classname>boost::signals::shared_connection_block</classname> object will
+<classname>boost::signalslib::shared_connection_block</classname> object will
temporarily block a slot. The connection is unblocked by either
destroying or calling
<methodname alt="shared_connection_block::unblock">unblock</methodname>
@@ -691,28 +691,28 @@
blocking/unblocking slots:</para>
<programlisting>
-boost::signals::connection c = sig.<methodname>connect</methodname>(HelloWorld());
+boost::signalslib::connection c = sig.<methodname>connect</methodname>(HelloWorld());
sig(); <emphasis>// Prints "Hello, World!"</emphasis>
{
- boost::signals::shared_connection_block block(c); <emphasis>// block the slot</emphasis>
+ boost::signalslib::shared_connection_block block(c); <emphasis>// block the slot</emphasis>
assert(c.<methodname>blocked</methodname>());
sig(); <emphasis>// No output: the slot is blocked</emphasis>
-}<emphasis>// shared_connection_block going out of scope unblocks the slot</emphasis>
+} <emphasis>// shared_connection_block going out of scope unblocks the slot</emphasis>
sig(); <emphasis>// Prints "Hello, World!"</emphasis>
</programlisting>
</section>
<section><title>Scoped connections (Intermediate)</title>
-<para>The <code>boost::signals::scoped_connection</code> class
+<para>The <code>boost::signalslib::scoped_connection</code> class
references a signal/slot connection that will be disconnected when
the <code>scoped_connection</code> class goes out of scope. This
ability is useful when a connection need only be temporary,
e.g.,</para>
<programlisting>
{
- boost::signals::scoped_connection c = sig.<methodname>connect</methodname>(ShortLived());
+ boost::signalslib::scoped_connection c = sig.<methodname>connect</methodname>(ShortLived());
sig(); <emphasis>// will call ShortLived function object</emphasis>
}
sig(); <emphasis>// ShortLived function object no longer connected to sig</emphasis>
@@ -722,7 +722,7 @@
<section><title>Disconnecting equivalent slots (Intermediate)</title>
<para>One can disconnect slots that are equivalent to a given function
object using a form of the
-<code><methodname>disconnect</methodname></code> method, so long as
+<code><methodname alt="signalN::disconnect">signal::disconnect</methodname></code> method, so long as
the type of the function object has an accessible <code>==</code>
operator. For instance:
@@ -877,11 +877,11 @@
<itemizedlist>
<listitem><para>The connection is explicitly disconnected via the connection's
<code>disconnect</code> method directly, or indirectly via the
-signal's <code>disconnect</code> method or
+signal's <code>disconnect</code> method, or
<code>scoped_connection</code>'s destructor.</para></listitem>
<listitem><para>An object tracked by the slot is
destroyed.</para></listitem>
-<listitem><para>A slot throws an <classname>boost::expired_slot</classname> exception.
+<listitem><para>A slot throws a <classname>boost::expired_slot</classname> exception.
</para></listitem>
<listitem><para>The signal is destroyed.</para></listitem></itemizedlist>
<para>These events can occur at any time without disrupting a signal's
@@ -1004,13 +1004,13 @@
{
public:
typedef boost::signal<void (bool)> signal_t;
- typedef boost::signals::connection connection_t;
+ typedef boost::signalslib::connection connection_t;
public:
Document()
{}
- connection_t connect(signal_t::slot_function_type subscriber)
+ connection_t connect(const signal_t::slot_type &subscriber)
{
return m_sig.connect(subscriber);
}
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