pw_containers: Fix intrusive doc lists

Change-Id: I6cb8eb65847f234532cf89c0ee89a629e5311ea9
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243255
Commit-Queue: Aaron Green <[email protected]>
Docs-Not-Needed: Aaron Green <[email protected]>
Lint: Lint 🤖 <[email protected]>
Presubmit-Verified: CQ Bot Account <[email protected]>
Reviewed-by: Wyatt Hepler <[email protected]>

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<T>::get_allocator
-///   std::forward_list<T>::emplace_after
-///   std::forward_list<T>::emplace_front
-///   std::forward_list<T>::resize
+/// - std::forward_list<T>::get_allocator
+/// - std::forward_list<T>::emplace_after
+/// - std::forward_list<T>::emplace_front
+/// - std::forward_list<T>::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<T>::(constructor)
-///   std::forward_list<T>::assign
-///   std::forward_list<T>::insert_after
+/// - std::forward_list<T>::(constructor)
+/// - std::forward_list<T>::assign
+/// - std::forward_list<T>::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<T>::insert_after
-///   std::forward_list<T>::push_front
-///   std::forward_list<T>::splice_after
+/// - std::forward_list<T>::insert_after
+/// - std::forward_list<T>::push_front
+/// - std::forward_list<T>::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<T>::insert_after
-///   std::forward_list<T>::erase_after
-///   std::forward_list<T>::splice_after
+/// - std::forward_list<T>::insert_after
+/// - std::forward_list<T>::erase_after
+/// - std::forward_list<T>::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 <typename T>

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<T>::get_allocator
-///   std::list<T>::emplace
-///   std::list<T>::emplace_front
-///   std::list<T>::emplace_back
-///   std::list<T>::resize
+/// - std::list<T>::get_allocator
+/// - std::list<T>::emplace
+/// - std::list<T>::emplace_front
+/// - std::list<T>::emplace_back
+/// - std::list<T>::resize
 ///
-/// * Methods corresponding to the following take initializer lists of pointer
-/// to items rather than the itenms themselves:
-///   std::list<T>::(constructor)
-///   std::list<T>::assign
-///   std::list<T>::insert
+/// - Methods corresponding to the following take initializer lists of pointer
+/// to items rather than the items themselves:
+/// - std::list<T>::(constructor)
+/// - std::list<T>::assign
+/// - std::list<T>::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<T>::insert
-///   std::list<T>::push_back
-///   std::list<T>::push_front
-///   std::list<T>::splice
+/// - std::list<T>::insert
+/// - std::list<T>::push_back
+/// - std::list<T>::push_front
+/// - std::list<T>::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<T>::insert
-///   std::list<T>::erase
-///   std::list<T>::splice
+/// - std::list<T>::insert
+/// - std::list<T>::erase
+/// - std::list<T>::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 <typename T>

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<T>::operator=
-///   std::map<T>::operator[]
-///   std::map<T>::get_allocator
-///   std::map<T>::insert_or_assign
-///   std::map<T>::emplace
-///   std::map<T>::emplace_hint
-///   std::map<T>::try_emplace
+/// - std::map<T>::operator=
+/// - std::map<T>::operator[]
+/// - std::map<T>::get_allocator
+/// - std::map<T>::insert_or_assign
+/// - std::map<T>::emplace
+/// - std::map<T>::emplace_hint
+/// - std::map<T>::try_emplace
 ///
-/// * Methods corresponding to the following take initializer lists of pointer
-/// to items rather than the itenms themselves:
-///   std::map<T>::(constructor)
-///   std::map<T>::insert
+/// - Methods corresponding to the following take initializer lists of pointer
+/// to items rather than the items themselves:
+/// - std::map<T>::(constructor)
+/// - std::map<T>::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<T>::insert
-///   std::map<T>::merge
+/// - std::map<T>::insert
+/// - std::map<T>::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<T>::insert
-///   std::map<T>::erase
+/// - std::map<T>::insert
+/// - std::map<T>::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.

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<T>::operator=
-///   std::multimap<T>::get_allocator
-///   std::multimap<T>::emplace
-///   std::multimap<T>::emplace_hint
+/// - std::multimap<T>::operator=
+/// - std::multimap<T>::get_allocator
+/// - std::multimap<T>::emplace
+/// - std::multimap<T>::emplace_hint
 ///
-/// * Methods corresponding to the following take initializer lists of pointer
-/// to items rather than the itenms themselves:
-///   std::multimap<T>::(constructor)
-///   std::multimap<T>::insert
+/// - Methods corresponding to the following take initializer lists of pointer
+/// to items rather than the items themselves:
+/// - std::multimap<T>::(constructor)
+/// - std::multimap<T>::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<T>::insert
-///   std::multimap<T>::merge
+/// - std::multimap<T>::insert
+/// - std::multimap<T>::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<T>::insert
-///   std::multimap<T>::erase
+/// - std::multimap<T>::insert
+/// - std::multimap<T>::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 <typename Key,
  typename T,
  typename Compare = std::less<Key>,