From b7cb79ac1cd1c7de57f71ec659d8c2214d41ca2a Mon Sep 17 00:00:00 2001 From: Felix Morgner Date: Fri, 3 Jan 2020 14:17:21 +0100 Subject: doc: replace struct by class for RTD compatibility --- doc/src/index.rst | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'doc') diff --git a/doc/src/index.rst b/doc/src/index.rst index 52de572..62abd58 100644 --- a/doc/src/index.rst +++ b/doc/src/index.rst @@ -453,13 +453,13 @@ Arithmetic Operators **enablement:** This operator shall be available iff. a) :cpp:type:`new_type::base_type` is divide-assignable using the operator :literal:`/=` and b) :cpp:type:`DerivationClause` includes :cpp:var:`Arithmetic`. -:cpp:struct:`std::hash` Support +:cpp:class:`std::hash` Support ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. cpp:namespace-pop:: -.. cpp:struct:: template \ - std::hash> +.. cpp:class:: template \ + std::hash> :tparam BaseType: |BaseTypeDoc| :tparam TagType: |TagTypeDoc| @@ -478,11 +478,11 @@ Header :literal:`` This header defines the alias template :cpp:type:`derivable` as well as the set of standard derivation tags. -Alias template :cpp:type:`derivable` +Class template :cpp:type:`derivable` ------------------------------------ -.. cpp:struct:: template \ - derivable +.. cpp:class:: template \ + derivable .. versionadded:: 1.0.0 @@ -491,51 +491,51 @@ Alias template :cpp:type:`derivable` Standard derivation tags ------------------------ -.. cpp:var:: auto constexpr Arithmetic = derivable{} +.. cpp:var:: auto constexpr Arithmetic = derivable{} This tag enables the derivation of the arithmetic operators :cpp:func:`operator+`, :cpp:func:`operator-`, :cpp:func:`operator*`, :cpp:func:`operator/`, :cpp:func:`operator+=`, :cpp:func:`operator-=`, :cpp:func:`operator*=`, and :cpp:func:`operator/=` .. versionadded:: 1.0.0 -.. cpp:var:: auto constexpr EqBase = derivable{} +.. cpp:var:: auto constexpr EqBase = derivable{} This tag enables the derivation of "Equality comparison with base type" operators :cpp:func:`operator==(BaseType, new_type) constexpr bool nt::operator==(BaseType const &, new_type const &)>`, :cpp:func:`operator==(new_type, BaseType) constexpr bool nt::operator==(new_type const &, BaseType const &)>` :cpp:func:`operator!=(BaseType, new_type) constexpr bool nt::operator!=(BaseType const &, new_type const &)>`, and :cpp:func:`operator!=(new_type, BaseType) constexpr bool nt::operator!=(new_type const &, BaseType const &)>` By virtue of its nature, deriving this feature compromises the strength of the given :cpp:class:`new_type`. .. versionadded:: 1.0.0 -.. cpp:var:: auto constexpr ImplicitConversion = derivable{} +.. cpp:var:: auto constexpr ImplicitConversion = derivable{} This tag enables the derivation of the implicit "conversion to base type" operator. By virtue of its nature, deriving this feature compromises the strength of the given :cpp:class:`new_type`. .. versionadded:: 1.0.0 -.. cpp:var:: auto constexpr Hash = derivable{} +.. cpp:var:: auto constexpr Hash = derivable{} - This tag enables the derivation of a specialization of :cpp:struct:`std::hash` + This tag enables the derivation of a specialization of :cpp:class:`std::hash` .. versionadded:: 1.0.0 -.. cpp:var:: auto constexpr Indirection = derivable{} +.. cpp:var:: auto constexpr Indirection = derivable{} This tag enables the derivation of the "member access through pointer" operators :cpp:func:`new_type::operator->` .. versionadded:: 1.0.0 -.. cpp:var:: auto constexpr Read = derivable{} +.. cpp:var:: auto constexpr Read = derivable{} This tag enables the derivation of the "stream output" operator :cpp:func:`operator<<` .. versionadded:: 1.0.0 -.. cpp:var:: auto constexpr Relational = derivable{} +.. cpp:var:: auto constexpr Relational = derivable{} This tag enables the derivation of the relational operators :cpp:func:`operator<`, :cpp:func:`operator>`, :cpp:func:`operator<=`, and :cpp:func:`operator>=` .. versionadded:: 1.0.0 -.. cpp:var:: auto constexpr Show = derivable{} +.. cpp:var:: auto constexpr Show = derivable{} This tag enables the derivation of the "stream input" operator :cpp:func:`operator>>` -- cgit v1.2.3