From b6dbb1cb0924c58a272236b682c73046ecbddf97 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ion=20Gazta=C3=B1aga?= <igaztanaga@gmail.com>
Date: Mon, 29 Aug 2016 00:04:58 +0200
Subject: [PATCH] Fix Doxygen warnings about missing documentation in some
 classes.

---
 include/boost/container/pmr/deque.hpp         | 2 ++
 include/boost/container/pmr/flat_map.hpp      | 4 ++++
 include/boost/container/pmr/flat_set.hpp      | 4 ++++
 include/boost/container/pmr/list.hpp          | 2 ++
 include/boost/container/pmr/map.hpp           | 4 ++++
 include/boost/container/pmr/set.hpp           | 4 ++++
 include/boost/container/pmr/slist.hpp         | 2 ++
 include/boost/container/pmr/small_vector.hpp  | 2 ++
 include/boost/container/pmr/stable_vector.hpp | 2 ++
 include/boost/container/pmr/string.hpp        | 2 ++
 include/boost/container/pmr/vector.hpp        | 2 ++
 include/boost/container/slist.hpp             | 5 ++++-
 12 files changed, 34 insertions(+), 1 deletion(-)

diff --git a/include/boost/container/pmr/deque.hpp b/include/boost/container/pmr/deque.hpp
index 7447586..acb7da3 100644
--- a/include/boost/container/pmr/deque.hpp
+++ b/include/boost/container/pmr/deque.hpp
@@ -29,6 +29,8 @@ using deque = boost::container::deque<T, polymorphic_allocator<T>>;
 
 #endif
 
+//! A portable metafunction to obtain a deque
+//! that uses a polymorphic allocator
 template<class T>
 struct deque_of
 {
diff --git a/include/boost/container/pmr/flat_map.hpp b/include/boost/container/pmr/flat_map.hpp
index 786c190..150d533 100644
--- a/include/boost/container/pmr/flat_map.hpp
+++ b/include/boost/container/pmr/flat_map.hpp
@@ -38,6 +38,8 @@ using flat_multimap = boost::container::flat_multimap<Key, T, Compare, polymorph
 
 #endif
 
+//! A portable metafunction to obtain a flat_map
+//! that uses a polymorphic allocator
 template <class Key
          ,class T
          ,class Compare  = std::less<Key>
@@ -47,6 +49,8 @@ struct flat_map_of
    typedef boost::container::flat_map<Key, T, Compare, polymorphic_allocator<std::pair<Key, T> > > type;
 };
 
+//! A portable metafunction to obtain a flat_multimap
+//! that uses a polymorphic allocator
 template <class Key
          ,class T
          ,class Compare  = std::less<Key>
diff --git a/include/boost/container/pmr/flat_set.hpp b/include/boost/container/pmr/flat_set.hpp
index 5c3ad1e..6d4292b 100644
--- a/include/boost/container/pmr/flat_set.hpp
+++ b/include/boost/container/pmr/flat_set.hpp
@@ -36,6 +36,8 @@ using flat_multiset = boost::container::flat_multiset<Key, Compare, polymorphic_
 
 #endif
 
+//! A portable metafunction to obtain a flat_set
+//! that uses a polymorphic allocator
 template <class Key
          ,class Compare = std::less<Key>
          ,class Options = tree_assoc_defaults >
@@ -44,6 +46,8 @@ struct flat_set_of
    typedef boost::container::flat_set<Key, Compare, polymorphic_allocator<Key> > type;
 };
 
+//! A portable metafunction to obtain a flat_multiset
+//! that uses a polymorphic allocator
 template <class Key
          ,class Compare = std::less<Key>
          ,class Options = tree_assoc_defaults >
diff --git a/include/boost/container/pmr/list.hpp b/include/boost/container/pmr/list.hpp
index 5967f45..8bac3ba 100644
--- a/include/boost/container/pmr/list.hpp
+++ b/include/boost/container/pmr/list.hpp
@@ -29,6 +29,8 @@ using list = boost::container::list<T, polymorphic_allocator<T>>;
 
 #endif
 
+//! A portable metafunction to obtain a deque
+//! that uses a polymorphic allocator
 template<class T>
 struct list_of
 {
diff --git a/include/boost/container/pmr/map.hpp b/include/boost/container/pmr/map.hpp
index fdada0e..165a473 100644
--- a/include/boost/container/pmr/map.hpp
+++ b/include/boost/container/pmr/map.hpp
@@ -38,6 +38,8 @@ using multimap = boost::container::multimap<Key, T, Compare, polymorphic_allocat
 
 #endif
 
+//! A portable metafunction to obtain a map
+//! that uses a polymorphic allocator
 template <class Key
          ,class T
          ,class Compare  = std::less<Key>
@@ -47,6 +49,8 @@ struct map_of
    typedef boost::container::map<Key, T, Compare, polymorphic_allocator<std::pair<const Key, T> >, Options> type;
 };
 
+//! A portable metafunction to obtain a multimap
+//! that uses a polymorphic allocator
 template <class Key
          ,class T
          ,class Compare  = std::less<Key>
diff --git a/include/boost/container/pmr/set.hpp b/include/boost/container/pmr/set.hpp
index 6f2c3bf..04583ce 100644
--- a/include/boost/container/pmr/set.hpp
+++ b/include/boost/container/pmr/set.hpp
@@ -36,6 +36,8 @@ using multiset = boost::container::multiset<Key, Compare, polymorphic_allocator<
 
 #endif
 
+//! A portable metafunction to obtain a set
+//! that uses a polymorphic allocator
 template <class Key
          ,class Compare = std::less<Key>
          ,class Options = tree_assoc_defaults >
@@ -44,6 +46,8 @@ struct set_of
    typedef boost::container::set<Key, Compare, polymorphic_allocator<Key>, Options> type;
 };
 
+//! A portable metafunction to obtain a multiset
+//! that uses a polymorphic allocator
 template <class Key
          ,class Compare = std::less<Key>
          ,class Options = tree_assoc_defaults >
diff --git a/include/boost/container/pmr/slist.hpp b/include/boost/container/pmr/slist.hpp
index 4ee76c6..c90fd7d 100644
--- a/include/boost/container/pmr/slist.hpp
+++ b/include/boost/container/pmr/slist.hpp
@@ -29,6 +29,8 @@ using slist = boost::container::slist<T, polymorphic_allocator<T>>;
 
 #endif
 
+//! A portable metafunction to obtain a slist
+//! that uses a polymorphic allocator
 template<class T>
 struct slist_of
 {
diff --git a/include/boost/container/pmr/small_vector.hpp b/include/boost/container/pmr/small_vector.hpp
index a79d5a0..6eef149 100644
--- a/include/boost/container/pmr/small_vector.hpp
+++ b/include/boost/container/pmr/small_vector.hpp
@@ -29,6 +29,8 @@ using small_vector = boost::container::small_vector<T, N, polymorphic_allocator<
 
 #endif
 
+//! A portable metafunction to obtain a small_vector
+//! that uses a polymorphic allocator
 template<class T, std::size_t N>
 struct small_vector_of
 {
diff --git a/include/boost/container/pmr/stable_vector.hpp b/include/boost/container/pmr/stable_vector.hpp
index 07a2059..d11c426 100644
--- a/include/boost/container/pmr/stable_vector.hpp
+++ b/include/boost/container/pmr/stable_vector.hpp
@@ -29,6 +29,8 @@ using stable_vector = boost::container::stable_vector<T, polymorphic_allocator<T
 
 #endif
 
+//! A portable metafunction to obtain a stable_vector
+//! that uses a polymorphic allocator
 template<class T>
 struct stable_vector_of
 {
diff --git a/include/boost/container/pmr/string.hpp b/include/boost/container/pmr/string.hpp
index 2e879e3..c1eba67 100644
--- a/include/boost/container/pmr/string.hpp
+++ b/include/boost/container/pmr/string.hpp
@@ -30,6 +30,8 @@ using basic_string =
 
 #endif
 
+//! A portable metafunction to obtain a basic_string
+//! that uses a polymorphic allocator
 template <class CharT, class Traits = std::char_traits<CharT> >
 struct basic_string_of
 {
diff --git a/include/boost/container/pmr/vector.hpp b/include/boost/container/pmr/vector.hpp
index cef6ae5..2bd9c15 100644
--- a/include/boost/container/pmr/vector.hpp
+++ b/include/boost/container/pmr/vector.hpp
@@ -29,6 +29,8 @@ using vector = boost::container::vector<T, polymorphic_allocator<T>>;
 
 #endif
 
+//! A portable metafunction to obtain a vector
+//! that uses a polymorphic allocator
 template<class T>
 struct vector_of
 {
diff --git a/include/boost/container/slist.hpp b/include/boost/container/slist.hpp
index 2b91eea..06863d6 100644
--- a/include/boost/container/slist.hpp
+++ b/include/boost/container/slist.hpp
@@ -1676,13 +1676,16 @@ namespace container {
 #include <boost/move/detail/std_ns_begin.hpp>
 BOOST_CONTAINER_DOC1ST(namespace std {, BOOST_MOVE_STD_NS_BEG)
 
+//! A specialization of insert_iterator
+//! that works with slist
 template <class T, class Allocator>
 class insert_iterator<boost::container::slist<T, Allocator> >
 {
- protected:
+   private:
    typedef boost::container::slist<T, Allocator> Container;
    Container* container;
    typename Container::iterator iter;
+
    public:
    typedef Container           container_type;
    typedef output_iterator_tag iterator_category;