Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r77504 - trunk/boost/container
From: igaztanaga_at_[hidden]
Date: 2012-03-23 13:51:21


Author: igaztanaga
Date: 2012-03-23 13:51:20 EDT (Fri, 23 Mar 2012)
New Revision: 77504
URL: http://svn.boost.org/trac/boost/changeset/77504

Log:
Fixed documentation comments
Text files modified:
   trunk/boost/container/scoped_allocator.hpp | 23 +++++++++++++----------
   1 files changed, 13 insertions(+), 10 deletions(-)

Modified: trunk/boost/container/scoped_allocator.hpp
==============================================================================
--- trunk/boost/container/scoped_allocator.hpp (original)
+++ trunk/boost/container/scoped_allocator.hpp 2012-03-23 13:51:20 EDT (Fri, 23 Mar 2012)
@@ -71,17 +71,9 @@
 //! by an argument of a type that satisfies the Allocator requirements
 struct allocator_arg_t{};
 
-static const allocator_arg_t allocator_arg = allocator_arg_t();
-
-//! <b>Remark</b>: Automatically detects if T has a nested allocator_type that is convertible from
-//! Alloc. Meets the BinaryTypeTrait requirements ([meta.rqmts] 20.4.1). A program may
-//! specialize this type to derive from true_type for a T of user-defined type if T does not
-//! have a nested allocator_type but is nonetheless constructible using the specified Alloc.
+//! A instance of type allocator_arg_t
 //!
-//! <b>Result</b>: derived from true_type if Convertible<Alloc,T::allocator_type> and
-//! derived from false_type otherwise.
-template <class T, class Alloc>
-struct uses_allocator;
+static const allocator_arg_t allocator_arg = allocator_arg_t();
 
 //! <b>Remark</b>: if a specialization is derived from true_type, indicates that T may be constructed
 //! with an allocator as its last constructor argument. Ideally, all constructors of T (including the
@@ -207,11 +199,22 @@
 
 } //namespace container_detail {
 
+///@endcond
+
+//! <b>Remark</b>: Automatically detects if T has a nested allocator_type that is convertible from
+//! Alloc. Meets the BinaryTypeTrait requirements ([meta.rqmts] 20.4.1). A program may
+//! specialize this type to derive from true_type for a T of user-defined type if T does not
+//! have a nested allocator_type but is nonetheless constructible using the specified Alloc.
+//!
+//! <b>Result</b>: derived from true_type if Convertible<Alloc,T::allocator_type> and
+//! derived from false_type otherwise.
 template <typename T, typename Alloc>
 struct uses_allocator
    : boost::integral_constant<bool, container_detail::uses_allocator_imp<T, Alloc>::value>
 {};
 
+///@cond
+
 namespace container_detail {
 
 template <typename Alloc>


Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk