feedc0de/cxx-ring-buffer
1
0
Fork 0
forked from Ferdi265/cxx-ring-buffer
Code Pull Requests Activity

document constexpr- and noexcept-ness of methods

Browse Source
This commit is contained in:
Ferdinand Bachmann
2020-04-22 15:58:41 +02:00
parent 1364f08e1f
commit 59eed9f73c
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -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<T, N>`
(defined in `<ring-buffer.h>`)