summaryrefslogtreecommitdiff
path: root/boost/hana/fwd/map.hpp
diff options
context:
space:
mode:
Diffstat (limited to 'boost/hana/fwd/map.hpp')
-rw-r--r--boost/hana/fwd/map.hpp8
1 files changed, 5 insertions, 3 deletions
diff --git a/boost/hana/fwd/map.hpp b/boost/hana/fwd/map.hpp
index c00f57195f..782b0f1e97 100644
--- a/boost/hana/fwd/map.hpp
+++ b/boost/hana/fwd/map.hpp
@@ -36,21 +36,23 @@ BOOST_HANA_NAMESPACE_BEGIN
//! keys must be `Hashable`, and any two keys with equal hashes must be
//! `Comparable` with each other at compile-time.
//!
- //! Note that the actual representation of a `hana::map` is an implementation
+ //! @note
+ //! The actual representation of a `hana::map` is an implementation
//! detail. As such, one should not assume anything more than what is
//! explicitly documented as being part of the interface of a map,
//! such as:
//! - the presence of additional constructors
//! - the presence of additional assignment operators
//! - the fact that `hana::map<Pairs...>` is, or is not, a dependent type
- //!
+ //! .
//! In particular, the last point is very important; `hana::map<Pairs...>`
//! is basically equivalent to
//! @code
//! decltype(hana::make_pair(std::declval<Pairs>()...))
//! @endcode
//! which is not something that can be pattern-matched on during template
- //! argument deduction, for example.
+ //! argument deduction, for example. More details [in the tutorial]
+ //! (@ref tutorial-containers-types).
//!
//!
//! Modeled concepts