From 1822e1c94fc68d612f63cb81400a448b9938f63c Mon Sep 17 00:00:00 2001 From: Clement Jamin Date: Tue, 26 Nov 2013 12:54:26 +0100 Subject: [PATCH] More detailed doc --- STL_Extension/doc/STL_Extension/CGAL/Compact_container.h | 3 ++- .../doc/STL_Extension/CGAL/Concurrent_compact_container.h | 8 +++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h b/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h index fa0c10c3968..721e032e046 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h @@ -488,7 +488,8 @@ size_type size() const; /// \name Access Member Functions /// @{ /*! -returns the maximum possible size of the container `cc`. +returns the maximum possible size of the container `cc`. +This is the allocator's max_size value. */ size_type max_size() const; diff --git a/STL_Extension/doc/STL_Extension/CGAL/Concurrent_compact_container.h b/STL_Extension/doc/STL_Extension/CGAL/Concurrent_compact_container.h index 52a2e967bb7..69c1b003305 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Concurrent_compact_container.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Concurrent_compact_container.h @@ -56,8 +56,9 @@ public: \ingroup CompactContainer An object of the class `Concurrent_compact_container` -is a container of objects of type `T`, which enables concurrency-safe -`insert` and `erase`. Other operations are not concurrency-safe. +is a container of objects of type `T`, which allows to call +`insert` and `erase` operations concurrently. +Other operations are not concurrency-safe. For example, one should not parse the container while others are modifying it. It matches all the standard requirements for reversible containers, except that @@ -227,7 +228,8 @@ complexity. No exception is thrown. /// returns the number of items in `ccc`. /// Note: do not call this function while others are inserting/erasing elements size_type size() const; - /// returns the maximum possible size of the container `ccc`. + /// returns the maximum possible size of the container `ccc`. + /// This is the allocator's max_size value size_type max_size() const; /// returns the total number of elements that `ccc` can hold without requiring reallocation. size_type capacity() const;