From 2b8f88b034b4dfc93dfe21bfd3b987770646d65e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ion=20Gazta=C3=B1aga?= Date: Fri, 3 Jan 2014 14:52:56 +0100 Subject: [PATCH] Documented template parameters --- include/boost/container/flat_map.hpp | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/include/boost/container/flat_map.hpp b/include/boost/container/flat_map.hpp index 95b9e5e..ff66e5d 100644 --- a/include/boost/container/flat_map.hpp +++ b/include/boost/container/flat_map.hpp @@ -76,6 +76,12 @@ static D force_copy(S s) //! pointing to elements that come after (their keys are bigger) the erased element. //! //! This container provides random-access iterators. +//! +//! \tparam Key is the key_type of the map +//! \tparam Value is the mapped_type +//! \tparam Compare is the ordering function for Keys (e.g. std::less). +//! \tparam Allocator is the allocator to allocate the value_types +//! (e.g. allocator< std::pair > ). #ifdef BOOST_CONTAINER_DOXYGEN_INVOKED template , class Allocator = std::allocator< std::pair< Key, T> > > #else @@ -966,6 +972,12 @@ namespace container { //! pointing to elements that come after (their keys are bigger) the erased element. //! //! This container provides random-access iterators. +//! +//! \tparam Key is the key_type of the map +//! \tparam Value is the mapped_type +//! \tparam Compare is the ordering function for Keys (e.g. std::less). +//! \tparam Allocator is the allocator to allocate the value_types +//! (e.g. allocator< std::pair > ). #ifdef BOOST_CONTAINER_DOXYGEN_INVOKED template , class Allocator = std::allocator< std::pair< Key, T> > > #else