diff options
author | Sven Gothel <[email protected]> | 2021-11-03 11:35:18 +0100 |
---|---|---|
committer | Sven Gothel <[email protected]> | 2021-11-03 11:35:18 +0100 |
commit | eaffb58b5e582d1bd3aa6c6ca0fd1656122825da (patch) | |
tree | c15415f22fe1489afe77cb9b21335fba025a1389 | |
parent | 3a8ddf47ba60045831a7d3056ee50a154dc5caae (diff) |
Fix Doxygen <tt> on '#### `something`', remove the code-qualifier
-rw-r--r-- | include/jau/cow_darray.hpp | 4 | ||||
-rw-r--r-- | include/jau/darray.hpp | 4 | ||||
-rw-r--r-- | include/jau/ringbuffer.hpp | 7 |
3 files changed, 8 insertions, 7 deletions
diff --git a/include/jau/cow_darray.hpp b/include/jau/cow_darray.hpp index e1486cd..8c5a0a9 100644 --- a/include/jau/cow_darray.hpp +++ b/include/jau/cow_darray.hpp @@ -105,9 +105,9 @@ namespace jau { * @anchor cow_darray_ntt_params * ### Non-Type Template Parameter controlling Value_type memory * See @ref darray_ntt_params. - * #### `use_memmove` + * #### use_memmove * `use_memmove` see @ref darray_memmove. - * #### `use_secmem` + * #### use_secmem * `use_secmem` see @ref darray_secmem. * * See also: diff --git a/include/jau/darray.hpp b/include/jau/darray.hpp index 0f08c0e..06d049d 100644 --- a/include/jau/darray.hpp +++ b/include/jau/darray.hpp @@ -95,7 +95,7 @@ namespace jau { * @anchor darray_ntt_params * ### Non-Type Template Parameter (NTTP) controlling Value_type memory * @anchor darray_memmove - * #### `use_memmove` + * #### use_memmove * `use_memmove` can be overriden and defaults to `std::is_trivially_copyable_v<Value_type>`. * * The default value has been chosen with care, see C++ Standard section 6.9 Types [TriviallyCopyable](https://en.cppreference.com/w/cpp/named_req/TriviallyCopyable). @@ -129,7 +129,7 @@ namespace jau { * - `typedef std::true_type container_memmove_compliant;` * * @anchor darray_secmem - * #### `use_secmem` + * #### use_secmem * `use_secmem` can be overriden and defaults to `false`. * * `use_secmem`, if enabled, ensures that the underlying memory will be zeroed out diff --git a/include/jau/ringbuffer.hpp b/include/jau/ringbuffer.hpp index 11c4250..3302b45 100644 --- a/include/jau/ringbuffer.hpp +++ b/include/jau/ringbuffer.hpp @@ -78,6 +78,7 @@ namespace jau { * Full [.][.][.][.][.][W][R][.] ; W==R-1 * </pre> * + * * ### Thread Safety * Thread safety is guaranteed, considering the mode of operation as described below. * @@ -123,10 +124,10 @@ namespace jau { * ### Non-Type Template Parameter (NTTP) controlling Value_type memory * See @ref darray_ntt_params. * - * #### `use_memmove` + * #### use_memmove * `use_memmove` see @ref darray_memmove. * - * #### `use_memcpy` + * #### use_memcpy * `use_memcpy` has more strict requirements than `use_memmove`, * i.e. strictly relies on Value_type being `std::is_trivially_copyable_v<Value_type>`. * @@ -138,7 +139,7 @@ namespace jau { * > Objects with trivial destructors don't require a delete-expression and may be disposed of by simply deallocating their storage. * > All data types compatible with the C language (POD types) are trivially destructible.` * - * #### `use_secmem` + * #### use_secmem * `use_secmem` see @ref darray_secmem. * * @see @ref darray_ntt_params |