boostorg/container
1
0
Fork 1
mirror of https://github.com/boostorg/container.git synced 2025-08-02 05:54:28 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix Doxygen warnings about missing documentation in some classes.

Browse Source
This commit is contained in:
Ion Gaztañaga
2016-08-29 00:04:58 +02:00
parent 1467c51a4e
commit b6dbb1cb09
12 changed files with 34 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
include/boost/container/pmr/deque.hpp
View File

@@ -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
{

4
include/boost/container/pmr/flat_map.hpp
View File

@@ -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>

4
include/boost/container/pmr/flat_set.hpp
View File

@@ -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 >

2
include/boost/container/pmr/list.hpp
View File

@@ -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
{

4
include/boost/container/pmr/map.hpp
View File

@@ -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>

4
include/boost/container/pmr/set.hpp
View File

@@ -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 >

2
include/boost/container/pmr/slist.hpp
View File

@@ -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
{

2
include/boost/container/pmr/small_vector.hpp
View File

@@ -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
{

2
include/boost/container/pmr/stable_vector.hpp
View File

@@ -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
{

2
include/boost/container/pmr/string.hpp
View File

@@ -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
{

2
include/boost/container/pmr/vector.hpp
View File

@@ -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
{

5
include/boost/container/slist.hpp
View File

@@ -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;