From db75b825ab983ac731516622898a706035473d15 Mon Sep 17 00:00:00 2001
From: Felix Morgner <felix.morgner@gmail.com>
Date: Sat, 22 Feb 2020 17:50:10 +0100
Subject: doc: reduce header inline documentation

---
 doc/src/index.rst | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/src/index.rst b/doc/src/index.rst
index e8d50d6..17101c9 100644
--- a/doc/src/index.rst
+++ b/doc/src/index.rst
@@ -180,14 +180,14 @@ Class template :cpp:class:`new_type`
 
    .. cpp:function:: constexpr BaseType decay() const
 
-      Retrieve the object contained by this :cpp:class:`new_type` object
+      Retrieve a copy of the object contained by this :cpp:class:`new_type` object
 
       :throws: Any exception thrown by the copy-constructor of this :cpp:class:`new_type`'s :cpp:type:`base_type`.
                This operator shall be noexcept iff. this :cpp:class:`new_type`'s :cpp:type:`base_type` is *nothrow copy-constructible*.
 
    .. cpp:function:: constexpr operator BaseType() const
 
-      Retrieve the object contained by this :cpp:class:`new_type` object
+      Retrieve a copy of the object contained by this :cpp:class:`new_type` object
 
       :throws: Any exception thrown by the copy-constructor of this :cpp:class:`new_type`'s :cpp:type:`base_type`.
                This operator shall be noexcept iff. this :cpp:class:`new_type`'s :cpp:type:`base_type` is *nothrow copy-constructible*.
@@ -443,6 +443,8 @@ Stream I/O Operators
                   typename StreamTraits> \
                   std::basic_ostream<CharType, StreamTraits> & operator<<(std::basic_ostream<CharType, StreamTraits> & out, new_type<BaseType, TagType, DerivationClause> const & value)
 
+   Write an instance of :cpp:class:`new_type\<BaseType, TagType, DerivationClause>` to a standard :cpp:type:`ostream <std::ostream>`.
+
    :tparam BaseType: |BaseTypeDoc|
    :tparam TagType: |TagTypeDoc|
    :tparam DerivationClause: |DerivationClauseDoc|
@@ -467,6 +469,8 @@ Stream I/O Operators
                   typename StreamTraits> \
                   std::basic_istream<CharType, StreamTraits> & operator>>(std::basic_istream<CharType, StreamTraits> & in, new_type<BaseType, TagType, DerivationClause> & value)
 
+   Read an instance of :cpp:class:`new_type\<BaseType, TagType, DerivationClause>` from a standard :cpp:type:`istream <std::istream>`.
+
    :tparam BaseType: |BaseTypeDoc|
    :tparam TagType: |TagTypeDoc|
    :tparam DerivationClause: |DerivationClauseDoc|
@@ -729,6 +733,8 @@ Iterators
    :tparam TagType: |TagTypeDoc|
    :tparam DerivationClause: |DerivationClauseDoc|
 
+   Hash an instance of :cpp:class:`new_type` using the hash implementation of the :cpp:type:`base type <BaseType>`.
+
    .. cpp:function:: constexpr std::size operator()(nt::new_type<BaseType, TagType, DerivationClause> const & value) const
 
       :param value: A :cpp:class:`nt::new_type` value to be hashed
-- 
cgit v1.2.3