boost/circular_buffer
2
0
Fork 0
mirror of https://github.com/boostorg/circular_buffer.git synced 2026-02-20 02:32:13 +00:00
Code Issues Projects Releases Wiki Activity

template param doc.

Browse Source 
[SVN r2926]
This commit is contained in:
Jan Gaspar
2006-04-17 22:21:37 +00:00
parent 0084546f18
commit 13c8718d76
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
include/boost/circular_buffer/base.hpp
View File

@@ -36,7 +36,14 @@ namespace boost {
\class circular_buffer
\brief Circular buffer - a STL compliant container.
\param T The type of the elements stored in the circular buffer.
<code>T</code> has to be <a href="http://www.sgi.com/tech/stl/Assignable.html">
SGIAssignable</a> (SGI STL defined combination of <a href="../../utility/Assignable.html">
Assignable</a> and <a href="../../utility/CopyConstructible.html">CopyConstructible</a>.
Moreover <code>T</code> has to be <a href="http://www.sgi.com/tech/stl/DefaultConstructible.html">
DefaultConstructible</a> if supplied as a default parameter during invocation of some methods
e.g. insert(iterator pos, const T& item = T()).
\param Alloc The allocator type used for all internal memory management.
The <code>Alloc</code> has to meet the allocator requirements imposed by STL.
Default: std::allocator<T>
\author Jan Gaspar
\version 3.7