[Boost-commit] svn:boost r85035 - trunk/libs/circular_buffer/doc

Subject: [Boost-commit] svn:boost r85035 - trunk/libs/circular_buffer/doc
From: pbristow_at_[hidden]
Date: 2013-07-14 12:32:46

Author: pbristow
Date: 2013-07-14 12:32:46 EDT (Sun, 14 Jul 2013)
New Revision: 85035
URL: http://svn.boost.org/trac/boost/changeset/85035

Log:
Updated to correct broken links.

Text files modified: 
   trunk/libs/circular_buffer/doc/circular_buffer.qbk |    25 ++++++++++++-------------               
   trunk/libs/circular_buffer/doc/jamfile.v2          |     6 +++---                                  
   2 files changed, 15 insertions(+), 16 deletions(-)

Modified: trunk/libs/circular_buffer/doc/circular_buffer.qbk
==============================================================================
--- trunk/libs/circular_buffer/doc/circular_buffer.qbk	Sun Jul 14 12:00:11 2013	(r85034)
+++ trunk/libs/circular_buffer/doc/circular_buffer.qbk	2013-07-14 12:32:46 EDT (Sun, 14 Jul 2013)	(r85035)
@@ -1,4 +1,4 @@
-[article Circular Buffer
+[article Boost.Circular Buffer
     [quickbook 1.6]
     [id circular_buffer]
     [copyright 2003-2013 Jan Gaspar]
@@ -46,7 +46,6 @@
 [def __min_capacity [memberref boost::circular_buffer_space_optimized::min_capacity() min_capacity]]
 [def __capacity_control [memberref boost::circular_buffer_space_optimized::capacity_control () capacity_control ]]
 
-
 [def __debug_support  [link circular_buffer.implmentation.debug_support debug support]]
 
 [include ../../../tools/auto_index/include/auto_index_helpers.qbk]
@@ -121,7 +120,7 @@
 
 [/circular_buffer_example_output - there is no output for this example]
 
-You can see the full example code at [@../../example/circular_buffer_example.cpp  circular_buffer_example.cpp].
+You can see the full example code at [@../../libs/circular_buffer/example/circular_buffer_example.cpp  circular_buffer_example.cpp].
 
 The full annotated description is in the C++ Reference section.
 
@@ -151,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 [@../../example/circular_buffer_bound_example.cpp  circular_buffer_bound_example.cpp]).
+(see the Bounded Buffer example, code at [@../../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.
@@ -175,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 [@../../example/circular_buffer_bound_example.cpp  circular_buffer_bound_example.cpp])
+(See the Bounded Buffer example code at [@../../libs/circular_buffer/example/circular_buffer_bound_example.cpp  circular_buffer_bound_example.cpp])
 
 [h3 Overwrite Operation]
 
@@ -266,7 +265,7 @@
 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
-[@../../test/soft_iterator_invalidation.cpp soft_iterator_invalidation.cpp].
+[@../../libs/circular_buffer/test/soft_iterator_invalidation.cpp soft_iterator_invalidation.cpp].
 
 [h3 Caveats]
 
@@ -305,7 +304,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/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)
@@ -338,7 +337,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 [@../../example/circular_buffer_sum_example.cpp  circular_buffer_sum_example.cpp].
+You can see the full example code at [@../../libs/circular_buffer/example/circular_buffer_sum_example.cpp  circular_buffer_sum_example.cpp].
 
 [h3 Bounded Buffer Example]
 
@@ -402,23 +401,23 @@
 
 [import ../test/bounded_buffer_comparison.cpp]
 
-You can see the full test code at [@../../test/bounded_buffer_comparison.cpp bounded_buffer_comparison.cpp],
+You can see the full test code at [@../../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/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/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/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/circular_buffer/space_optimized.hpp space_optimized.hpp].
 
 [endsect] [/section:headers Header Files]
 

Modified: trunk/libs/circular_buffer/doc/jamfile.v2
==============================================================================
--- trunk/libs/circular_buffer/doc/jamfile.v2	Sun Jul 14 12:00:11 2013	(r85034)
+++ trunk/libs/circular_buffer/doc/jamfile.v2	2013-07-14 12:32:46 EDT (Sun, 14 Jul 2013)	(r85035)
@@ -14,9 +14,9 @@
 path-constant pdf_images_location : html ; # location of SVG and PNG images referenced by pdf.
 path-constant here : . ; # location of /doc folder.
 
-echo "nav_images = " $(nav_images) ; # "nav_images = I:\boost-trunk\libs\circular_buffer\doc\html\images
-echo "images_location = " $(images_location) ; # images_location = I:\boost-trunk\libs\circular_buffer\doc\html\images
-echo "pdf_images_location = " $(pdf_images_location) # 
+# echo "nav_images = " $(nav_images) ; # "nav_images = I:\boost-trunk\libs\circular_buffer\doc\html\images
+# echo "images_location = " $(images_location) ; # images_location = I:\boost-trunk\libs\circular_buffer\doc\html\images
+# echo "pdf_images_location = " $(pdf_images_location) # 
 import modules ;
 using auto-index ;
 using doxygen ;  # Required if you want to use Doxygen.