From 59eed9f73cc1f105f9f47e3fac2948bb0ef40a7f Mon Sep 17 00:00:00 2001 From: Ferdinand Bachmann Date: Wed, 22 Apr 2020 15:58:41 +0200 Subject: [PATCH] document constexpr- and noexcept-ness of methods --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 60c4d12..0a5b833 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,15 @@ The last 3 options set preprocessor defines with the same name when enabled. ## Documentation +All member functions and constructors of the following types are `constexpr` if +the `RING_BUFFER_CONSTEXPR` feature is enabled. + +All member functions and constructors of the following types are `noexcept` or +conditionally `noexcept` if the `RING_BUFFER_NOEXCEPT` feature is enabled. + +Destructors of the following types are explicitly marked as `constexpr` if the +`RING_BUFFER_CONSTEXPR_DESTRUCTORS` feature is enabled. + ### `class ring_buffer` (defined in ``)