summaryrefslogtreecommitdiffstats
path: root/include/jau/cow_vector.hpp
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2021-01-05 00:55:09 +0100
committerSven Gothel <[email protected]>2021-01-05 00:55:09 +0100
commitb773d7620246f690f14f797d217359f785138089 (patch)
tree1a88a5a9a34b601fae44ea6bb99db7e1bc3b443d /include/jau/cow_vector.hpp
parentd7a2c3a1e6a3c780102a23f3cc03d88fd7f56f6c (diff)
Adding jau::for_each_fidelity with documentation 'Usage of const_iterator to call non-const methods' and 'Use const_iterator over iterator with CoW if possible'
Tagging unit tests as examples!
Diffstat (limited to 'include/jau/cow_vector.hpp')
-rw-r--r--include/jau/cow_vector.hpp6
1 files changed, 5 insertions, 1 deletions
diff --git a/include/jau/cow_vector.hpp b/include/jau/cow_vector.hpp
index 1dc0143..5223f82 100644
--- a/include/jau/cow_vector.hpp
+++ b/include/jau/cow_vector.hpp
@@ -93,7 +93,11 @@ namespace jau {
* - Sequentially Consistent (SC) ordering or SC-DRF (data race free) <https://en.cppreference.com/w/cpp/atomic/memory_order#Sequentially-consistent_ordering>
* - std::memory_order <https://en.cppreference.com/w/cpp/atomic/memory_order>
* </pre>
- * \deprecated { jau::cow_vector will be retired, use jau::cow_darray and potentially jau::darray. }
+ * \deprecated jau::cow_vector will be retired, use jau::cow_darray and potentially jau::darray.
+ * @see jau::cow_darray
+ * @see jau::cow_ro_iterator
+ * @see jau::for_each_fidelity
+ * @see jau::cow_rw_iterator
*/
template <typename Value_type, typename Alloc_type = std::allocator<Value_type>>
class cow_vector