diff --git a/doc/HOWTO-srcdoc b/doc/HOWTO-srcdoc index eac259e..d5abd2f 100644 --- a/doc/HOWTO-srcdoc +++ b/doc/HOWTO-srcdoc @@ -2,7 +2,7 @@ # HOW-TO documentation about generating/updating source code documentation for # # the Circular Buffer library. # # # -# Copyright (c) 2006 Jan Gaspar # +# Copyright (c) 2007 Jan Gaspar # # # # Use, modification, and distribution is subject to the Boost Software # # License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at # diff --git a/doc/circular_buffer.html b/doc/circular_buffer.html index fe8415f..4c5c660 100644 --- a/doc/circular_buffer.html +++ b/doc/circular_buffer.html @@ -983,7 +983,7 @@ template <class T, class Alloc>
circular_buffer (including iterators equal to
+ end()).
+ circular_buffer).
circular_buffer.
- circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ index is invalid (when index
- >= size()).
- circular_buffer).
+ std::out_of_range when the index is invalid (when index >= size()).
circular_buffer).
+ index is invalid (when index
- >= size()).
- circular_buffer).
+ std::out_of_range when the index is invalid (when index >= size()).
circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ T::operator = (const T&) throws.
circular_buffer); constant if the postcondition is already met.
- circular_buffer; does not invalidate any
- iterators if the postcondition is already met prior calling this method.
+ Invalidates all iterators pointing to the circular_buffer (except iterators equal to
+ end()); does not
+ invalidate any iterators if the postcondition is already met prior calling this method.
+ circular_buffer); constant if the postcondition is already met.
circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ capacity() ==
+ new_capacity && size() <=
new_capacitycircular_buffer is greater than the
desired new capacity then number of [size() - new_capacity]
- last elements will be removed.
+ last elements will be removed and the new size will be equal to new_capacity.
T::T(const T&) throws.
circular_buffer).
- circular_buffer if the new capacity is different
- from the original.
+ Invalidates all iterators pointing to the circular_buffer (except iterators equal to
+ end()) if the new
+ capacity is different from the original.
+ circular_buffer).
T::T(const T&) throws.
circular_buffer).
- circular_buffer if the new size is different
- from the original.
+ Invalidates all iterators pointing to the circular_buffer (except iterators equal to
+ end()) if the new size
+ is greater than the current capacity. Invalidates iterators pointing to the removed elements if the new
+ size is lower that the original size. Otherwise it does not invalidate any iterator.
+ circular_buffer).
capacity() ==
+ new_capacity && size() <=
new_capacitycircular_buffer is greater than the
desired new capacity then number of [size() - new_capacity]
- first elements will be removed.
+ first elements will be removed and the new size will be equal to new_capacity.
T::T(const T&) throws.
circular_buffer).
- circular_buffer if the new capacity is different
- from the original.
+ Invalidates all iterators pointing to the circular_buffer (except iterators equal to
+ end()) if the new
+ capacity is different from the original.
+ circular_buffer).
circular_buffer will be filled with in order to gain the requested
- size. (See the postcondition.)
+ size. (See the Effect.)
T::T(const T&) throws.
- circular_buffer).
- circular_buffer if the new size is different
- from the original.
+ Invalidates all iterators pointing to the circular_buffer (except iterators equal to
+ end()) if the new size
+ is greater than the current capacity. Invalidates iterators pointing to the removed elements if the new
+ size is lower that the original size. Otherwise it does not invalidate any iterator.
+ circular_buffer).
T::T(const T&) throws.
cb).
- circular_buffer.
cb).
+ T::T(const T&) throws.
n).
- circular_buffer.
n).
+ T::T(const T&) throws.
n).
- circular_buffer.
n).
+ T::T(const T&) throws.
std::distance(first, last)).
- circular_buffer.
std::distance(first, last)).
+
The capacity of the circular_buffer will be set to the specified value and the content of
the circular_buffer will be removed and replaced with copies of elements from the specified
- range. (See the postcondition.)
+ range. (See the Effect.)
T::T(const T&) throws.
std::distance(first, last)).
- circular_buffer.
std::distance(first, last)).
+ circular_buffer).
- circular_buffer).
+ T::T(const T&) throws.
circular_buffer).
- circular_buffer).
+ T::T(const T&) throws.
circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer).
+ begin() if the
- item is not inserted. (See the postcondition.)
+ item is not inserted. (See the Effect.)
T::operator = (const T&) throws.
circular_buffer).
+ circular_buffer.T::operator = (const T&) throws.
pos) and
+ iterators behind the insertion point (towards the end). It also invalidates iterators pointing to the
+ overwritten elements.
+ circular_buffer).
+ |1|2|0|0|0|0|0|3|4|.
pos) and
- iterators behind the insertion point (towards the end). It also invalidates iterators pointing to the
- overwritten elements.
- circular_buffer.T::T(const T&) throws.
+ T::operator = (const T&) throws.
+ pos) and
+ iterators behind the insertion point (towards the end). It also invalidates iterators pointing to the
+ overwritten elements.
+ circular_buffer).
+ |1|2|5|6|7|8|9|3|4|.
T::T(const T&) throws.
- T::operator = (const T&) throws.
- pos) and
- iterators behind the insertion point (towards the end). It also invalidates iterators pointing to the
- overwritten elements.
- end() if the
- item is not inserted. (See the postcondition.)
+ item is not inserted. (See the Effect.)
T::operator = (const T&) throws.
pos). It also invalidates iterators pointing to the overwritten element.
circular_buffer).
+ circular_buffer.T::operator = (const T&) throws.
pos). It also invalidates iterators pointing to the overwritten elements.
+ circular_buffer).
+ |1|2|0|0|0|0|0|3|4|.
pos). It also invalidates iterators pointing to the overwritten elements.
- circular_buffer.T::T(const T&) throws.
+ T::operator = (const T&) throws.
+ pos). It also invalidates iterators pointing to the overwritten elements.
+ circular_buffer).
+ |1|2|5|6|7|8|9|3|4|.
T::T(const T&) throws.
- T::operator = (const T&) throws.
- pos). It also invalidates iterators pointing to the overwritten elements.
- pos is removed.
pos
+ T::operator = (const T&) throws.
circular_buffer).
- circular_buffer).
+ first
+ last
+ T::operator = (const T&) throws.
circular_buffer).
- circular_buffer).
+ pos is a valid iterator pointing to the circular_buffer or its end.
+ pos is a valid iterator pointing to the circular_buffer (but not an
+ end()).
pos is removed.
pos
+ T::operator = (const T&) throws.
circular_buffer).
- circular_buffer).
+ [first, last) are removed.
first
+ last
+ T::operator = (const T&) throws.
circular_buffer).
- circular_buffer).
+ circular_buffer).
- circular_buffer.
circular_buffer).
+ - Copyright © 2003-2006 Jan Gaspar + Copyright © 2003-2007 Jan Gaspar
Use, modification, and distribution is subject to the Boost Software License, Version 1.0.
- Copyright © 2003-2006 Jan Gaspar
+ Copyright © 2003-2007 Jan Gaspar
Use, modification, and distribution is subject to the Boost Software License, Version 1.0.
diff --git a/doc/circular_buffer.xslt b/doc/circular_buffer.xslt
index a87d3a6..4117111 100644
--- a/doc/circular_buffer.xslt
+++ b/doc/circular_buffer.xslt
@@ -3,7 +3,7 @@
XSL transformation from the XML files generated by Doxygen into XHTML source
code documentation of the circular_buffer.
-Copyright (c) 2006 Jan Gaspar
+Copyright (c) 2007 Jan Gaspar
Use, modification, and distribution is subject to the Boost Software
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
diff --git a/doc/circular_buffer_space_optimized.html b/doc/circular_buffer_space_optimized.html
index c3bf0d5..12c9a70 100644
--- a/doc/circular_buffer_space_optimized.html
+++ b/doc/circular_buffer_space_optimized.html
@@ -1333,7 +1333,7 @@ template <class T, class Alloc>
diff --git a/doc/circular_buffer_space_optimized.xslt b/doc/circular_buffer_space_optimized.xslt
index 3293c11..1de5db4 100644
--- a/doc/circular_buffer_space_optimized.xslt
+++ b/doc/circular_buffer_space_optimized.xslt
@@ -3,7 +3,7 @@
XSL transformation from the XML files generated by Doxygen into XHTML source
code documentation of the circular_buffer_space_optimized.
-Copyright (c) 2006 Jan Gaspar
+Copyright (c) 2007 Jan Gaspar
Use, modification, and distribution is subject to the Boost Software
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
diff --git a/doc/copy.xslt b/doc/copy.xslt
index 499fb86..95f5f10 100644
--- a/doc/copy.xslt
+++ b/doc/copy.xslt
@@ -2,7 +2,7 @@