Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r86209 - in branches/release: . doc doc/html doc/src libs libs/circular_buffer libs/circular_buffer/doc libs/circular_buffer/doc/images
From: dnljms_at_[hidden]
Date: 2013-10-08 17:01:18

Author: danieljames
Date: 2013-10-08 17:01:18 EDT (Tue, 08 Oct 2013)
New Revision: 86209
URL: http://svn.boost.org/trac/boost/changeset/86209

Log:
Merge circular buffer documentation fixes.

Added:
   branches/release/doc/html/circular_buffer.html
      - copied unchanged from r85000, trunk/doc/html/circular_buffer.html
   branches/release/libs/circular_buffer/doc/images/
      - copied from r86196, trunk/libs/circular_buffer/doc/images/
Properties modified:
   branches/release/ (props changed)
   branches/release/doc/ (props changed)
   branches/release/libs/ (props changed)
   branches/release/libs/circular_buffer/ (props changed)
Text files modified:
   branches/release/doc/Jamfile.v2 | 3 +++
   branches/release/doc/html/circular_buffer.html | 17 +++++++++++++++++
   branches/release/doc/src/boost.xml | 14 +++-----------
   branches/release/libs/circular_buffer/doc/circular_buffer.qbk | 32 ++++++++++++++++----------------
   branches/release/libs/circular_buffer/doc/jamfile.v2 | 4 +++-
   5 files changed, 42 insertions(+), 28 deletions(-)

Modified: branches/release/doc/Jamfile.v2
==============================================================================
--- branches/release/doc/Jamfile.v2 Tue Oct 8 16:24:11 2013 (r86208)
+++ branches/release/doc/Jamfile.v2 2013-10-08 17:01:18 EDT (Tue, 08 Oct 2013) (r86209)
@@ -40,6 +40,7 @@
     <dependency>../libs/accumulators/doc//statsdoc.xml
     <dependency>../libs/accumulators/doc//opdoc.xml
     <dependency>../libs/accumulators/doc//accumulators
+ <dependency>../libs/circular_buffer/doc//standalone/<format>docbook
     <dependency>../libs/conversion/doc//lexical_cast
     <dependency>../libs/chrono/doc//chrono
     <dependency>../libs/program_options/doc//autodoc.xml
@@ -102,6 +103,7 @@
     <implicit-dependency>../tools/build/v2/doc//jam_docs
     <implicit-dependency>../tools/quickbook/doc//quickbook
     <implicit-dependency>../libs/mpi/doc//mpi
+ <implicit-dependency>../libs/circular_buffer/doc//standalone/<format>docbook
     <implicit-dependency>../libs/container/doc//standalone/<format>docbook
     <implicit-dependency>../libs/interprocess/doc//standalone/<format>docbook
     <implicit-dependency>../libs/intrusive/doc//standalone/<format>docbook
@@ -130,3 +132,4 @@

+

Copied: branches/release/doc/html/circular_buffer.html (from r85000, trunk/doc/html/circular_buffer.html)
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ branches/release/doc/html/circular_buffer.html 2013-10-08 17:01:18 EDT (Tue, 08 Oct 2013) (r86209, copy of r85000, trunk/doc/html/circular_buffer.html)
@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+ 
+ <title>Redirect to generated documentation</title>
+ <meta http-equiv="refresh" content="0; URL=http://boost-sandbox.sourceforge.net/doc/html/circular_buffer.html">
+ </head>
+ <body>
+ Automatic redirection failed, please go to
+ http://boost-sandbox.sourceforge.net/doc/html/circular_buffer.html
+ </body>
+</html>
+

Modified: branches/release/doc/src/boost.xml
==============================================================================
--- branches/release/doc/src/boost.xml Tue Oct 8 16:24:11 2013 (r86208)
+++ branches/release/doc/src/boost.xml 2013-10-08 17:01:18 EDT (Tue, 08 Oct 2013) (r86209)
@@ -98,17 +98,7 @@

    <xi:include href="chrono.xml"/>

- <library name="Circular Buffer" dirname="circular_buffer" html-only="1"
- url="../../libs/circular_buffer/index.html">
- <libraryinfo>
- <author>
- <firstname>Jan</firstname>
- <surname>Gaspar</surname>
- </author>
- <librarypurpose>A STL compliant container also known as ring or cyclic buffer</librarypurpose>
- <librarycategory name="category:containers"/>
- </libraryinfo>
- </library>
+ <xi:include href="circular_buffer.auto_index.docbook"/>

    <library name="Compatibility" dirname="compatibility" html-only="1">
      <libraryinfo>
@@ -774,3 +764,5 @@

+
+

Modified: branches/release/libs/circular_buffer/doc/circular_buffer.qbk
==============================================================================
--- branches/release/libs/circular_buffer/doc/circular_buffer.qbk Tue Oct 8 16:24:11 2013 (r86208)
+++ branches/release/libs/circular_buffer/doc/circular_buffer.qbk 2013-10-08 17:01:18 EDT (Tue, 08 Oct 2013) (r86209)
@@ -81,11 +81,11 @@
when the capacity is adjusted explicitly,
or as necessary to accommodate resizing or assign operations.

-[$images/circular_buffer.png]
+[$../../libs/circular_buffer/doc/images/circular_buffer.png]

There is also a __cbso version available.

-[$images/space_optimized.png]
+[$../../libs/circular_buffer/doc/images/space_optimized.png]

__cbso is an adaptation of the __cb
which [*does not allocate memory all at once when created],
@@ -120,7 +120,7 @@

[/circular_buffer_example_output - there is no output for this example]

-You can see the full example code at [@../../libs/circular_buffer/example/circular_buffer_example.cpp circular_buffer_example.cpp].
+You can see the full example code at [@boost:libs/circular_buffer/example/circular_buffer_example.cpp circular_buffer_example.cpp].

The full annotated description is in the C++ Reference section.

@@ -150,7 +150,7 @@

* Storage of the ['most recently received samples], overwriting the oldest as new samples arrive.
* As an underlying container for a ['bounded buffer]
-(see the Bounded Buffer example, code at [@../../libs/circular_buffer/example/circular_buffer_bound_example.cpp circular_buffer_bound_example.cpp]).
+(see the Bounded Buffer example, code at [@boost:libs/circular_buffer/example/circular_buffer_bound_example.cpp circular_buffer_bound_example.cpp]).
* A kind of ['cache] storing a specified number of last inserted elements.
* Efficient fixed capacity ['FIFO (First In, First Out)],
* Efficient fixed capacity ['LIFO (Last In, First Out)] queue which removes the oldest (inserted as first) elements when full.
@@ -174,7 +174,7 @@
then the user is responsible for ensuring mutual exclusion between the threads during the container accesses.
The mutual exclusion between the threads can be achieved by wrapping
operations of the underlying __cb with a lock acquisition and release.
-(See the Bounded Buffer example code at [@../../libs/circular_buffer/example/circular_buffer_bound_example.cpp circular_buffer_bound_example.cpp])
+(See the Bounded Buffer example code at [@boost:libs/circular_buffer/example/circular_buffer_bound_example.cpp circular_buffer_bound_example.cpp])

[h3 Overwrite Operation]

@@ -265,13 +265,13 @@
This "soft" definition of iterator invalidation is supported by the __cb
but should be considered as an implementation detail rather than a full-fledged feature.
The rules when the iterator is still valid can be inferred from the code in
-[@../../libs/circular_buffer/test/soft_iterator_invalidation.cpp soft_iterator_invalidation.cpp].
+[@boost:libs/circular_buffer/test/soft_iterator_invalidation.cpp soft_iterator_invalidation.cpp].

[h3 Move emulation and rvalues]

Since Boost 1.54.0 support for move semantics was implemented using
-the [@boost:libs/move/doc/html/move.html Boost.Move] library.
+the [@boost:libs/move/index.html Boost.Move] library.
If rvalue references are available __cb will use them, but if not it uses a close,
but imperfect emulation. On such compilers:

@@ -307,7 +307,7 @@
* If `value` has a throwing move constructor and some copy constructor, then method may throw exceptions of copy constructor.
* If `value` has no copy constructor, then method may throw exceptions of move constructor.

-`move_if_noexcept(T&)` uses [@boost:libs/move/doc/html/move.html Boost.Move], [@boost:libs/type_traits/doc/html/boost_typetraits/reference/is_copy_constructible.html `is_copy_constructible`], [@boost:libs/type_traits/doc/html/boost_typetraits/reference/is_nothrow_move_assignable.html `is_nothrow_move_assignable`] and [@boost:libs/type_traits/doc/html/boost_typetraits/reference/is_nothrow_move_constructible.html `is_nothrow_move_constructible`] type triats.
+`move_if_noexcept(T&)` uses [@boost:libs/move/index.html Boost.Move], [@boost:libs/type_traits/doc/html/boost_typetraits/reference/is_copy_constructible.html `is_copy_constructible`], [@boost:libs/type_traits/doc/html/boost_typetraits/reference/is_nothrow_move_assignable.html `is_nothrow_move_assignable`] and [@boost:libs/type_traits/doc/html/boost_typetraits/reference/is_nothrow_move_constructible.html `is_nothrow_move_constructible`] type triats.

[h3 Caveats]
@@ -347,7 +347,7 @@

Moreover, the uninitialized memory allocated by __cb is filled with the value `0xcc` in the debug mode.
When debugging the code, this can help the programmer to recognize the initialized memory from the uninitialized.
-For details refer the source code [@../../boost/circular_buffer/debug.hpp circular_buffer/debug.hpp].
+For details refer the source code [@boost:boost/circular_buffer/debug.hpp circular_buffer/debug.hpp].

The debug support is enabled only in the debug mode (when the `NDEBUG` is not defined).
It can also be explicitly disabled (only for __cb)
@@ -380,7 +380,7 @@
The `std::accumulate` algorithm evaluates the sum of the stored elements.
The semantics of the __cb can be inferred from the assertions.

-You can see the full example code at [@../../libs/circular_buffer/example/circular_buffer_sum_example.cpp circular_buffer_sum_example.cpp].
+You can see the full example code at [@boost:libs/circular_buffer/example/circular_buffer_sum_example.cpp circular_buffer_sum_example.cpp].

[h3 Bounded Buffer Example]

@@ -436,7 +436,7 @@
(removal) of an old item and a consequent inplace construction (insertion) of a new item.

For comparison of bounded buffers based on different containers compile and
-run [@../../test/bounded_buffer_comparison.cpp bounded_buffer_comparison.cpp].
+run [@boost:libs/circular_buffer/test/bounded_buffer_comparison.cpp bounded_buffer_comparison.cpp].
The test should reveal the bounded buffer based on the __cb is most effective
closely followed by the `std::deque` based bounded buffer.
(In reality, the result may differ sometimes because the test
@@ -444,23 +444,23 @@

[import ../test/bounded_buffer_comparison.cpp]

-You can see the full test code at [@../../libs/circular_buffer/test/bounded_buffer_comparison.cpp bounded_buffer_comparison.cpp],
+You can see the full test code at [@boost:libs/circular_buffer/test/bounded_buffer_comparison.cpp bounded_buffer_comparison.cpp],
and an example of output is [bounded_buffer_comparison_output].

[endsect] [/section:examples More examples]

[section:headers Header Files]

-The circular buffer library is defined in the file [@../../boost/circular_buffer.hpp circular_buffer.hpp].
+The circular buffer library is defined in the file [@boost:boost/circular_buffer.hpp circular_buffer.hpp].

#include <boost/circular_buffer.hpp>

(There is also a forward declaration for the __cb
-in the header file [@../../boost/circular_buffer_fwd.hpp circular_buffer_fwd.hpp]).
+in the header file [@boost:boost/circular_buffer_fwd.hpp circular_buffer_fwd.hpp]).

-The __cb is defined in the file [@../../boost/circular_buffer/base.hpp base.hpp].
+The __cb is defined in the file [@boost:boost/circular_buffer/base.hpp base.hpp].

-The __cbso is defined in the file [@../../boost/circular_buffer/space_optimized.hpp space_optimized.hpp].
+The __cbso is defined in the file [@boost:boost/circular_buffer/space_optimized.hpp space_optimized.hpp].

[endsect] [/section:headers Header Files]

Modified: branches/release/libs/circular_buffer/doc/jamfile.v2
==============================================================================
--- branches/release/libs/circular_buffer/doc/jamfile.v2 Tue Oct 8 16:24:11 2013 (r86208)
+++ branches/release/libs/circular_buffer/doc/jamfile.v2 2013-10-08 17:01:18 EDT (Tue, 08 Oct 2013) (r86209)
@@ -106,7 +106,9 @@

    # General settings
    # =================
- <xsl:param>boost.root=../../../..
+ <format>html:<xsl:param>boost.root=../../../..
+ <format>html:<xsl:param>img.src.path=../../../../doc/html/
+ <format>docbook:<xsl:param>boost.root=boost:

     # Options for html and pdf
     # ========================

Date view	Thread view	Subject view	Author view

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