From 13c8718d76eebdce217ec1b8ab48488207ade1b0 Mon Sep 17 00:00:00 2001 From: Jan Gaspar Date: Mon, 17 Apr 2006 22:21:37 +0000 Subject: [PATCH] template param doc. [SVN r2926] --- include/boost/circular_buffer/base.hpp | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/include/boost/circular_buffer/base.hpp b/include/boost/circular_buffer/base.hpp index 57f3941..c8544af 100644 --- a/include/boost/circular_buffer/base.hpp +++ b/include/boost/circular_buffer/base.hpp @@ -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. + T has to be + SGIAssignable (SGI STL defined combination of + Assignable and CopyConstructible. + Moreover T has to be + DefaultConstructible 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 Alloc has to meet the allocator requirements imposed by STL. Default: std::allocator \author Jan Gaspar \version 3.7