aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@gmail.com>2020-01-02 12:34:40 +0100
committerFelix Morgner <felix.morgner@gmail.com>2020-01-02 12:34:40 +0100
commit8207d74330bfa214144bac70db8b4dd5f0c3f3b1 (patch)
tree6887e348f57fde7483b2180ae36f2f0c75caa8d8 /doc
parent61656a5a1b213b919c7361e804c56e83cb3b1985 (diff)
downloadnewtype-8207d74330bfa214144bac70db8b4dd5f0c3f3b1.tar.xz
newtype-8207d74330bfa214144bac70db8b4dd5f0c3f3b1.zip
doc: add missing doc for operator-
Diffstat (limited to 'doc')
-rw-r--r--doc/src/index.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/src/index.rst b/doc/src/index.rst
index 6c341c2..7f75ec4 100644
--- a/doc/src/index.rst
+++ b/doc/src/index.rst
@@ -284,6 +284,15 @@ Arithmetic Operators
**enablement:** This operator shall be available iff. a) :cpp:type:`new_type<BaseType, TagType, DerivationClause>::base_type` is addable using the operator :literal:`+` and b) :cpp:type:`DerivationClause` includes :cpp:var:`Arithmetic`.
+.. cpp:function:: template<typename BaseType, \
+ typename TagType, \
+ auto DerivationClause> \
+ constexpr new_type<BaseType, TagType, DerivationClause> operator-(new_type<BaseType, TagType, DerivationClause> const & lhs, new_type<BaseType, TagType, DerivationClause> const & rhs)
+
+ **noexcept specification:** This input operator shall be noexcept iff. :cpp:type:`new_type<BaseType, TagType, DerivationClause>::base_type` is nothrow subtractable as well as nothrow copy-constructible.
+
+ **enablement:** This operator shall be available iff. a) :cpp:type:`new_type<BaseType, TagType, DerivationClause>::base_type` is subtractable using the operator :literal:`-` and b) :cpp:type:`DerivationClause` includes :cpp:var:`Arithmetic`.
+
Header :literal:`<newtype/derivable.hpp>`
=========================================