diff --git a/pw_containers/public/pw_containers/intrusive_forward_list.h b/pw_containers/public/pw_containers/intrusive_forward_list.h index 207f5d247..c2d81adb7 100644 --- a/pw_containers/public/pw_containers/intrusive_forward_list.h +++ b/pw_containers/public/pw_containers/intrusive_forward_list.h @@ -53,33 +53,33 @@ class LegacyIntrusiveList; /// This class is modeled on `std::forward_list`, with the following /// differences: /// -/// * Since items are not allocated by this class, the following methods have +/// - Since items are not allocated by this class, the following methods have /// no analogue: -/// std::forward_list::get_allocator -/// std::forward_list::emplace_after -/// std::forward_list::emplace_front -/// std::forward_list::resize +/// - std::forward_list::get_allocator +/// - std::forward_list::emplace_after +/// - std::forward_list::emplace_front +/// - std::forward_list::resize /// -/// * Methods corresponding to the following take initializer lists of pointer +/// - Methods corresponding to the following take initializer lists of pointer /// to items rather than the itenms themselves: -/// std::forward_list::(constructor) -/// std::forward_list::assign -/// std::forward_list::insert_after +/// - std::forward_list::(constructor) +/// - std::forward_list::assign +/// - std::forward_list::insert_after /// -/// * There are no overloads corresponding to the following methods that take +/// - There are no overloads corresponding to the following methods that take /// r-value references.: -/// std::forward_list::insert_after -/// std::forward_list::push_front -/// std::forward_list::splice_after +/// - std::forward_list::insert_after +/// - std::forward_list::push_front +/// - std::forward_list::splice_after /// -/// * Since modifying the list modifies the items themselves, methods +/// - Since modifying the list modifies the items themselves, methods /// corresponding to those below only take `iterator`s and not /// `const_iterator`s: -/// std::forward_list::insert_after -/// std::forward_list::erase_after -/// std::forward_list::splice_after +/// - std::forward_list::insert_after +/// - std::forward_list::erase_after +/// - std::forward_list::splice_after /// -/// * C++23 methods are not (yet) supported. +/// - C++23 methods are not (yet) supported. /// /// @tparam T Type of intrusive items stored in the list. template diff --git a/pw_containers/public/pw_containers/intrusive_list.h b/pw_containers/public/pw_containers/intrusive_list.h index cdfe540dd..d5b0e9b26 100644 --- a/pw_containers/public/pw_containers/intrusive_list.h +++ b/pw_containers/public/pw_containers/intrusive_list.h @@ -44,35 +44,35 @@ namespace containers::future { /// /// This class is modeled on `std::list`, with the following differences: /// -/// * Since items are not allocated by this class, the following methods have +/// - Since items are not allocated by this class, the following methods have /// no analogue: -/// std::list::get_allocator -/// std::list::emplace -/// std::list::emplace_front -/// std::list::emplace_back -/// std::list::resize +/// - std::list::get_allocator +/// - std::list::emplace +/// - std::list::emplace_front +/// - std::list::emplace_back +/// - std::list::resize /// -/// * Methods corresponding to the following take initializer lists of pointer -/// to items rather than the itenms themselves: -/// std::list::(constructor) -/// std::list::assign -/// std::list::insert +/// - Methods corresponding to the following take initializer lists of pointer +/// to items rather than the items themselves: +/// - std::list::(constructor) +/// - std::list::assign +/// - std::list::insert /// -/// * There are no overloads corresponding to the following methods that take +/// - There are no overloads corresponding to the following methods that take /// r-value references.: -/// std::list::insert -/// std::list::push_back -/// std::list::push_front -/// std::list::splice +/// - std::list::insert +/// - std::list::push_back +/// - std::list::push_front +/// - std::list::splice /// -/// * Since modifying the list modifies the items themselves, methods +/// - Since modifying the list modifies the items themselves, methods /// corresponding to those below only take `iterator`s and not /// `const_iterator`s: -/// std::list::insert -/// std::list::erase -/// std::list::splice +/// - std::list::insert +/// - std::list::erase +/// - std::list::splice /// -/// * C++23 methods are not (yet) supported. +/// - C++23 methods are not (yet) supported. /// /// @tparam T Type of intrusive items stored in the list. template diff --git a/pw_containers/public/pw_containers/intrusive_map.h b/pw_containers/public/pw_containers/intrusive_map.h index dc9b38899..9a099a6c5 100644 --- a/pw_containers/public/pw_containers/intrusive_map.h +++ b/pw_containers/public/pw_containers/intrusive_map.h @@ -76,37 +76,37 @@ class IntrusiveMapItemWithKey : public containers::internal::IntrusiveMapItem< /// This map requires unique keys. Attempting to add an item with same key as an /// item already in the map will fail. /// -/// * Since items are not allocated by this class, the following methods have +/// - Since items are not allocated by this class, the following methods have /// no analogue: -/// std::map::operator= -/// std::map::operator[] -/// std::map::get_allocator -/// std::map::insert_or_assign -/// std::map::emplace -/// std::map::emplace_hint -/// std::map::try_emplace +/// - std::map::operator= +/// - std::map::operator[] +/// - std::map::get_allocator +/// - std::map::insert_or_assign +/// - std::map::emplace +/// - std::map::emplace_hint +/// - std::map::try_emplace /// -/// * Methods corresponding to the following take initializer lists of pointer -/// to items rather than the itenms themselves: -/// std::map::(constructor) -/// std::map::insert +/// - Methods corresponding to the following take initializer lists of pointer +/// to items rather than the items themselves: +/// - std::map::(constructor) +/// - std::map::insert /// -/// * There are no overloads corresponding to the following methods that take +/// - There are no overloads corresponding to the following methods that take /// r-value references.: -/// std::map::insert -/// std::map::merge +/// - std::map::insert +/// - std::map::merge /// -/// * Since modifying the map modifies the items themselves, methods +/// - Since modifying the map modifies the items themselves, methods /// corresponding to those below only take `iterator`s and not /// `const_iterator`s: -/// std::map::insert -/// std::map::erase +/// - std::map::insert +/// - std::map::erase /// -/// * C++23 methods are not (yet) supported. +/// - C++23 methods are not (yet) supported. /// /// @tparam Key Type to sort items on /// @tparam T Type of values stored in the map. -/// @tparam Compare Function with the signature `bool(Key, Key) that is +/// @tparam Compare Function with the signature `bool(Key, Key)` that is /// used to order items. /// @tparam GetKey Function with signature `Key(const T&)` that /// returns the value that items are sorted on. diff --git a/pw_containers/public/pw_containers/intrusive_multimap.h b/pw_containers/public/pw_containers/intrusive_multimap.h index b4d087d95..e28af29ae 100644 --- a/pw_containers/public/pw_containers/intrusive_multimap.h +++ b/pw_containers/public/pw_containers/intrusive_multimap.h @@ -27,37 +27,37 @@ namespace pw { /// This map requires unique keys. Attempting to add an item with same key as an /// item already in the map will fail. /// -/// * Since items are not allocated by this class, the following methods have +/// - Since items are not allocated by this class, the following methods have /// no analogue: -/// std::multimap::operator= -/// std::multimap::get_allocator -/// std::multimap::emplace -/// std::multimap::emplace_hint +/// - std::multimap::operator= +/// - std::multimap::get_allocator +/// - std::multimap::emplace +/// - std::multimap::emplace_hint /// -/// * Methods corresponding to the following take initializer lists of pointer -/// to items rather than the itenms themselves: -/// std::multimap::(constructor) -/// std::multimap::insert +/// - Methods corresponding to the following take initializer lists of pointer +/// to items rather than the items themselves: +/// - std::multimap::(constructor) +/// - std::multimap::insert /// -/// * There are no overloads corresponding to the following methods that take +/// - There are no overloads corresponding to the following methods that take /// r-value references.: -/// std::multimap::insert -/// std::multimap::merge +/// - std::multimap::insert +/// - std::multimap::merge /// -/// * Since modifying the map modifies the items themselves, methods +/// - Since modifying the map modifies the items themselves, methods /// corresponding to those below only take `iterator`s and not /// `const_iterator`s: -/// std::multimap::insert -/// std::multimap::erase +/// - std::multimap::insert +/// - std::multimap::erase /// -/// * C++23 methods are not (yet) supported. +/// - C++23 methods are not (yet) supported. /// /// @tparam Key Type to sort items on /// @tparam T Type of values stored in the map. +/// @tparam Compare Function with the signature `bool(Key, Key)` that is +/// used to order items. /// @tparam GetKey Function with signature `Key(const T&)` that /// returns the value that items are sorted on. -/// @tparam Compare Function with the signature `bool(Key, Key) that is -/// used to order items. template ,