diff --git a/doc/circular_buffer.html b/doc/circular_buffer.html index 77319cf..44e113a 100644 --- a/doc/circular_buffer.html +++ b/doc/circular_buffer.html @@ -985,8 +985,47 @@ template <class T, class Alloc> "#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type get_allocator() const;

- Return the allocator.
-
+ Get the allocator. +
+
+ Returns: +
+
+ The allocator. +
+
+
+
+ Throws: +
+
+ Nothing. +
+
+
+
+ Complexity: +
+
+ Constant. +
+
+
+
+ Exception Safety: +
+
+ No-throw. +
+
+
+
+ Iterator Invalidation: +
+
+ Does not invalidate any iterator. +
+
@@ -996,7 +1035,47 @@ template <class T, class Alloc> "#classboost_1_1circular__buffer_14e07c6ddfe89debe384e59bed06e7cb7">allocator_type& get_allocator();

- Return the allocator. + Get the allocator reference. +
+
+ Returns: +
+
+ A reference to the allocator. +
+
+
+
+ Throws: +
+
+ Nothing. +
+
+
+
+ Complexity: +
+
+ Constant. +
+
+
+
+ Exception Safety: +
+
+ No-throw. +
+
+
+
+ Iterator Invalidation: +
+
+ Does not invalidate any iterator. +
+
Note: @@ -1329,7 +1408,7 @@ template <class T, class Alloc> Complexity:
- Linear in the size of the circular_buffer; constant if the postcondition is already met. + Linear (in the size of the circular_buffer); constant if the postcondition is already met.
@@ -1337,7 +1416,7 @@ template <class T, class Alloc> Exception Safety:
- Basic. + Basic; no-throw if the operations in the Throws do not throw anything.
@@ -1345,8 +1424,8 @@ template <class T, class Alloc> Iterator Invalidation:
- Invalidates all iterators pointing to the circular_buffer; does not invalidate any iterator if the - postcondition is already met prior calling this method. + Invalidates all iterators pointing to the circular_buffer; does not invalidate any + iterator if the postcondition is already met prior calling this method.
@@ -1354,8 +1433,8 @@ template <class T, class Alloc> Warning:
- In general invoking any method which modifies the internal state of the circular_buffer may delinearize - the internal buffer and invalidate the returned pointer. + In general invoking any method which modifies the internal state of the circular_buffer + may delinearize the internal buffer and invalidate the returned pointer.
diff --git a/include/boost/circular_buffer/base.hpp b/include/boost/circular_buffer/base.hpp index 1babbb4..f9559b4 100644 --- a/include/boost/circular_buffer/base.hpp +++ b/include/boost/circular_buffer/base.hpp @@ -174,11 +174,29 @@ private: public: // Allocator - //! Return the allocator. + //! Get the allocator. + /*! + \return The allocator. + \throws Nothing. + \par Complexity + Constant. + \par Exception Safety + No-throw. + \par Iterator Invalidation + Does not invalidate any iterator. + */ allocator_type get_allocator() const { return m_alloc; } - //! Return the allocator. + //! Get the allocator reference. /*! + \return A reference to the allocator. + \throws Nothing. + \par Complexity + Constant. + \par Exception Safety + No-throw. + \par Iterator Invalidation + Does not invalidate any iterator. \note This method was added in order to optimize obtaining of the allocator with a state, although use of stateful allocators in STL is discouraged. */ @@ -310,13 +328,13 @@ public: \throws Whatever T::T(const T&) throws. \throws Whatever T::operator = (const T&) throws. \par Complexity - Linear in the size of the circular_buffer; constant if the postcondition is already met. + Linear (in the size of the circular_buffer); constant if the postcondition is already met. \par Exception Safety - Basic. + Basic; no-throw if the operations in the Throws do not throw anything. \par Iterator Invalidation - Invalidates all iterators pointing to the circular_buffer; does not invalidate any iterator + Invalidates all iterators pointing to the circular_buffer; does not invalidate any iterator if the postcondition is already met prior calling this method. - \warning In general invoking any method which modifies the internal state of the circular_buffer + \warning In general invoking any method which modifies the internal state of the circular_buffer may delinearize the internal buffer and invalidate the returned pointer. \note This is not the only way how to pass data into the legacy C API - see array_one() and array_two() for the other option. diff --git a/include/boost/circular_buffer/space_optimized.hpp b/include/boost/circular_buffer/space_optimized.hpp index 804deb0..7905432 100644 --- a/include/boost/circular_buffer/space_optimized.hpp +++ b/include/boost/circular_buffer/space_optimized.hpp @@ -71,7 +71,7 @@ public: \pre capacity >= min_capacity

The m_capacity denotes the capacity of the circular_buffer_space_optimized and the m_min_capacity - deterimines the minimal allocated size of its internal buffer.

+ determines the minimal allocated size of its internal buffer.

The converting constructor of the capacity_control allows implicit conversion from size_type like types which ensures compatibility of creating an instance of the