Subject: [Boost-commit] svn:boost r50691 - sandbox/thread_safe_signals/trunk/libs/signals2/doc
From: fmhess_at_[hidden]
Date: 2009-01-20 16:27:19
Author: fmhess
Date: 2009-01-20 16:27:19 EST (Tue, 20 Jan 2009)
New Revision: 50691
URL: http://svn.boost.org/trac/boost/changeset/50691
Log:
Removed design overview section, as it was obsolete (even with respect
to the original Boost.Signals I believe, since it seems to think
boost::any is used to store slot functions).
Removed:
sandbox/thread_safe_signals/trunk/libs/signals2/doc/design.xml
Text files modified:
sandbox/thread_safe_signals/trunk/libs/signals2/doc/Makefile | 1 -
sandbox/thread_safe_signals/trunk/libs/signals2/doc/signals.xml | 1 -
2 files changed, 0 insertions(+), 2 deletions(-)
Modified: sandbox/thread_safe_signals/trunk/libs/signals2/doc/Makefile
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/Makefile (original)
+++ sandbox/thread_safe_signals/trunk/libs/signals2/doc/Makefile 2009-01-20 16:27:19 EST (Tue, 20 Jan 2009)
@@ -4,7 +4,6 @@
BOOSTBOOK_TOOL_DIR=$(BOOST_SRC_DIR)/tools/boostbook
XML_SRCS=\
- design.xml \
faq.xml \
introduction.xml \
porting.xml \
Deleted: sandbox/thread_safe_signals/trunk/libs/signals2/doc/design.xml
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/design.xml 2009-01-20 16:27:19 EST (Tue, 20 Jan 2009)
+++ (empty file)
@@ -1,87 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE section PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
- "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
-<section last-revision="$Date: 2007-06-12 14:01:23 -0400 (Tue, 12 Jun 2007) $" id="signals2.design">
- <title>Design Overview</title>
-
- <using-namespace name="boost"/>
- <using-namespace name="boost::signals"/>
-
- <section>
- <title>Slot Call Iterator</title>
-
- <para> The slot call iterator is conceptually a stack of iterator
- adaptors that modify the behavior of the underlying iterator
- through the list of slots. The following table describes the type
- and behavior of each iterator adaptor required. Note that this is
- only a conceptual model: the implementation collapses all these
- layers into a single iterator adaptor because several popular
- compilers failed to compile the implementation of the conceptual
- model.</para>
-
- <informaltable>
- <tgroup cols="2" align="left">
- <thead>
- <row>
- <entry>Iterator Adaptor</entry>
- <entry>Purpose</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Slot List Iterator</para></entry>
- <entry><para>An iterator through the list of slots
- connected to a signal. The <code>value_type</code> of this
- iterator will be
- <code><classname>std::pair</classname><any,
- connection></code>, where the
- <code><classname>any</classname></code> contains an
- instance of the slot function type.</para></entry>
- </row>
- <row>
- <entry><para>Filter Iterator Adaptor</para></entry>
- <entry><para>This filtering iterator adaptor filters out
- slots that have been disconnected, so we never see a
- disconnected slot in later stages.</para></entry>
- </row>
- <row>
- <entry><para>Projection Iterator Adaptor</para></entry>
- <entry><para>The projection iterator adaptor returns a
- reference to the first member of the pair that constitutes
- a connected slot (e.g., just the
- <code><classname>boost::any</classname></code> object that
- holds the slot function).</para></entry>
- </row>
- <row>
- <entry><para>Transform Iterator Adaptor</para></entry>
- <entry><para>This transform iterator adaptor performs an
- <code><functionname>any_cast</functionname></code> to
- extract a reference to the slot function with the
- appropriate slot function type.</para></entry>
- </row>
- <row>
- <entry><para>Transform Iterator Adaptor</para></entry>
- <entry><para>This transform iterator adaptor calls the
- function object returned by dereferencing the underlying
- iterator with the set of arguments given to the signal
- itself, and returns the result of that slot
- call.</para></entry>
- </row>
- <row>
- <entry><para>Input Caching Iterator Adaptor</para></entry>
- <entry><para>This iterator adaptor caches the result of
- dereferencing the underlying iterator. Therefore,
- dereferencing this iterator multiple times will only
- result in the underlying iterator being dereferenced once;
- thus, a slot can only be called once but its result can be
- used multiple times.</para></entry>
- </row>
- <row>
- <entry><para>Slot Call Iterator</para></entry>
- <entry><para>Iterates over calls to each slot.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
-</section>
Modified: sandbox/thread_safe_signals/trunk/libs/signals2/doc/signals.xml
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/signals.xml (original)
+++ sandbox/thread_safe_signals/trunk/libs/signals2/doc/signals.xml 2009-01-20 16:27:19 EST (Tue, 20 Jan 2009)
@@ -47,7 +47,6 @@
<xi:include href="tutorial.xml"/>
<xi:include href="reference/reference.xml"/>
<xi:include href="faq.xml"/>
- <xi:include href="design.xml"/>
<xi:include href="rationale.xml"/>
<xi:include href="porting.xml"/>
<xi:include href="tests.xml"/>