From 88515803707b1d4466bcb939a73a3ec8f5055a50 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ion=20Gazta=C3=B1aga?= <igaztanaga@gmail.com>
Date: Mon, 7 Sep 2015 19:06:45 +0200
Subject: [PATCH] Documentation fixes

---
 include/boost/container/flat_set.hpp      |  6 +++---
 include/boost/container/new_allocator.hpp |  4 ++++
 include/boost/container/set.hpp           |  9 ++++++---
 include/boost/container/small_vector.hpp  | 17 +++++++++++------
 include/boost/container/static_vector.hpp |  6 +++---
 5 files changed, 27 insertions(+), 15 deletions(-)

diff --git a/include/boost/container/flat_set.hpp b/include/boost/container/flat_set.hpp
index 8f59279..a99e707 100644
--- a/include/boost/container/flat_set.hpp
+++ b/include/boost/container/flat_set.hpp
@@ -968,17 +968,17 @@ class flat_multiset
       : base_t(static_cast<const base_t&>(x))
    {}
 
-   //! @copydoc ::boost::container::flat_set(flat_set &&)
+   //! @copydoc ::boost::container::flat_set::flat_set(flat_set &&)
    flat_multiset(BOOST_RV_REF(flat_multiset) x)
       : base_t(boost::move(static_cast<base_t&>(x)))
    {}
 
-   //! @copydoc ::boost::container::flat_set(const flat_set &, const allocator_type &)
+   //! @copydoc ::boost::container::flat_set::flat_set(const flat_set &, const allocator_type &)
    flat_multiset(const flat_multiset& x, const allocator_type &a)
       : base_t(static_cast<const base_t&>(x), a)
    {}
 
-   //! @copydoc ::boost::container::flat_set(flat_set &&, const allocator_type &)
+   //! @copydoc ::boost::container::flat_set::flat_set(flat_set &&, const allocator_type &)
    flat_multiset(BOOST_RV_REF(flat_multiset) x, const allocator_type &a)
       : base_t(BOOST_MOVE_BASE(base_t, x), a)
    {}
diff --git a/include/boost/container/new_allocator.hpp b/include/boost/container/new_allocator.hpp
index 1ac15d8..6a1d8c7 100644
--- a/include/boost/container/new_allocator.hpp
+++ b/include/boost/container/new_allocator.hpp
@@ -29,6 +29,8 @@
 namespace boost {
 namespace container {
 
+/// @cond
+
 template<bool Value>
 struct new_allocator_bool
 {  static const bool value = Value;  };
@@ -36,6 +38,8 @@ struct new_allocator_bool
 template<class T>
 class new_allocator;
 
+/// @endcond
+
 //! Specialization of new_allocator for void types
 template<>
 class new_allocator<void>
diff --git a/include/boost/container/set.hpp b/include/boost/container/set.hpp
index 79fa1ae..ca05cac 100644
--- a/include/boost/container/set.hpp
+++ b/include/boost/container/set.hpp
@@ -253,6 +253,9 @@ class set
    {  return static_cast<set&>(this->base_t::operator=(BOOST_MOVE_BASE(base_t, x)));  }
 
 #if !defined(BOOST_NO_CXX11_HDR_INITIALIZER_LIST)
+   //! <b>Effects</b>: Copy all elements from il to *this.
+   //!
+   //! <b>Complexity</b>: Linear in il.size().
    set& operator=(std::initializer_list<value_type> il)
    {
       this->clear();
@@ -851,17 +854,17 @@ class multiset
       : base_t(static_cast<const base_t&>(x))
    {}
 
-   //! @copydoc ::boost::container::set(set &&)
+   //! @copydoc ::boost::container::set::set(set &&)
    multiset(BOOST_RV_REF(multiset) x)
       : base_t(BOOST_MOVE_BASE(base_t, x))
    {}
 
-   //! @copydoc ::boost::container::set(const set &, const allocator_type &)
+   //! @copydoc ::boost::container::set::set(const set &, const allocator_type &)
    multiset(const multiset& x, const allocator_type &a)
       : base_t(static_cast<const base_t&>(x), a)
    {}
 
-   //! @copydoc ::boost::container::set(set &&, const allocator_type &)
+   //! @copydoc ::boost::container::set::set(set &&, const allocator_type &)
    multiset(BOOST_RV_REF(multiset) x, const allocator_type &a)
       : base_t(BOOST_MOVE_BASE(base_t, x), a)
    {}
diff --git a/include/boost/container/small_vector.hpp b/include/boost/container/small_vector.hpp
index a9f7522..4dab684 100644
--- a/include/boost/container/small_vector.hpp
+++ b/include/boost/container/small_vector.hpp
@@ -117,9 +117,9 @@ class small_vector_allocator
    typedef typename allocator_traits<Allocator>::propagate_on_container_copy_assignment   propagate_on_container_copy_assignment;
    typedef typename allocator_traits<Allocator>::propagate_on_container_move_assignment   propagate_on_container_move_assignment;
    typedef typename allocator_traits<Allocator>::propagate_on_container_swap              propagate_on_container_swap;
-   //! An integral constant with member `::value == false`
+   //! An integral constant with member `value == false`
    typedef BOOST_CONTAINER_IMPDEF(container_detail::bool_<false>)                         is_always_equal;
-   //! An integral constant with member `::value == true`
+   //! An integral constant with member `value == true`
    typedef BOOST_CONTAINER_IMPDEF(container_detail::bool_<true>)                          is_partially_propagable;
 
    BOOST_CONTAINER_DOCIGN(typedef container_detail::version_type<small_vector_allocator BOOST_CONTAINER_I 1>  version;)
@@ -289,20 +289,25 @@ class small_vector_allocator
 //! This class consists of common code from all small_vector<T, N> types that don't depend on the
 //! "N" template parameter. This class is non-copyable and non-destructible, so this class tipically
 //! used as reference argument to functions that read or write small vectors. Since `small_vector<T, N>`
-//! derives from `small_vector_base<T>`, the conversion to `small_vector_base` is implicit:
-//! <code>
+//! derives from `small_vector_base<T>`, the conversion to `small_vector_base` is implicit
+//! <pre>
 //!
 //! //Clients can pass any small_vector<Foo, N>.
 //! void read_any_small_vector_of_foo(const small_vector_base<Foo> &in_parameter);
+//!
 //! void modify_any_small_vector_of_foo(small_vector_base<Foo> &out_parameter);
-//! 
+//!
 //! void some_function()
 //! {
+//! 
 //!    small_vector<Foo, 8> myvector;
+//!
 //!    read_any_small_vector_of_foo(myvector);   // Reads myvector
+//!
 //!    modify_any_small_vector_of_foo(myvector); // Modifies myvector
+//! 
 //! }
-//! </code>
+//! </pre>
 //!
 //! All `boost::container:vector` member functions are inherited. See `vector` documentation for details.
 //!
diff --git a/include/boost/container/static_vector.hpp b/include/boost/container/static_vector.hpp
index c36832d..b6e0551 100644
--- a/include/boost/container/static_vector.hpp
+++ b/include/boost/container/static_vector.hpp
@@ -645,7 +645,7 @@ public:
     //!
     //! @brief Assigns a range <tt>[il.begin(), il.end())</tt> of Values to this container.
     //!
-    //! @param first       std::initializer_list with values used to construct new content of this container.
+    //! @param il       std::initializer_list with values used to construct new content of this container.
     //!
     //! @par Throws
     //!   If Value's copy constructor or copy assignment throws,
@@ -809,7 +809,7 @@ public:
     //!
     //! @brief Returns the index of the element pointed by p.
     //!
-    //! @param i    The element's index.
+    //! @param p    An iterator to the element.
     //!
     //! @return The index of the element pointed by p.
     //!
@@ -824,7 +824,7 @@ public:
     //!
     //! @brief Returns the index of the element pointed by p.
     //!
-    //! @param i    The index of the element pointed by p.
+    //! @param p    A const_iterator to the element.
     //!
     //! @return a const_iterator to the i-th element.
     //!