aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorFelix Morgner <felix.morgner@gmail.com>2019-12-29 23:55:50 +0100
committerFelix Morgner <felix.morgner@gmail.com>2019-12-29 23:55:50 +0100
commit17b5aca0e087820cf0545ac6923242676dd042d6 (patch)
tree7d13cf87c294768ae77a8a0a617132aa7b84125c /include
parent1b11319ee70b294535aa60e3a562cd2443d77d39 (diff)
downloadnewtype-17b5aca0e087820cf0545ac6923242676dd042d6.tar.xz
newtype-17b5aca0e087820cf0545ac6923242676dd042d6.zip
doc: document header derivable.hpp
Diffstat (limited to 'include')
-rw-r--r--include/newtype/derivable.hpp5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/newtype/derivable.hpp b/include/newtype/derivable.hpp
index 1b6651f..d5672ac 100644
--- a/include/newtype/derivable.hpp
+++ b/include/newtype/derivable.hpp
@@ -27,11 +27,12 @@ namespace nt
auto constexpr Arithmetic = derivable<struct arithmetic_tag>{};
/**
- * @brief A tag to enable derivation of equality comparison operators
+ * @brief A tag to enable derivation of "equality comparison with base type" operators
*
+ * @note Deriving this feature seriously weakens the using nt::new_type instance
* @since 1.0.0
*/
- auto constexpr EqBase = derivable<struct eq_tag>{};
+ auto constexpr EqBase = derivable<struct eq_base_tag>{};
/**
* @brief A tag to enable derivation of the implicit "conversion to base type" operator