feedc0de/boost_unordered
1
0
Fork 0
forked from boostorg/unordered
Code Pull Requests Activity

Update docs to describe the returned proxy type as "convertible to iterator"

Browse Source
This commit is contained in:
Christian Mazakas
2023-06-19 14:33:10 -07:00
parent 671b68f4d1
commit 704b3c7a4b
4 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/unordered/unordered_flat_map.adoc
View File

@ -154,8 +154,8 @@ namespace boost {
template<class K, class M>
iterator xref:#unordered_flat_map_insert_or_assign_with_hint[insert_or_assign](const_iterator hint, K&& k, M&& obj);
_implementation-defined_ xref:#unordered_flat_map_erase_by_position[erase](iterator position);
_implementation-defined_ xref:#unordered_flat_map_erase_by_position[erase](const_iterator position);
_convertible-to-iterator_ xref:#unordered_flat_map_erase_by_position[erase](iterator position);
_convertible-to-iterator_ xref:#unordered_flat_map_erase_by_position[erase](const_iterator position);
size_type xref:#unordered_flat_map_erase_by_key[erase](const key_type& k);
template<class K> size_type xref:#unordered_flat_map_erase_by_key[erase](K&& k);
iterator xref:#unordered_flat_map_erase_range[erase](const_iterator first, const_iterator last);
@ -1036,8 +1036,8 @@ The `template<class K, class M>` only participates in overload resolution if `Ha
[source,c++,subs=+quotes]
----
_implementation-defined_ erase(iterator position);
_implementation-defined_ erase(const_iterator position);
_convertible-to-iterator_ erase(iterator position);
_convertible-to-iterator_ erase(const_iterator position);
----
Erase the element pointed to by `position`.

8
doc/unordered/unordered_flat_set.adoc
View File

@ -122,8 +122,8 @@ namespace boost {
template<class InputIterator> void xref:#unordered_flat_set_insert_iterator_range[insert](InputIterator first, InputIterator last);
void xref:#unordered_flat_set_insert_initializer_list[insert](std::initializer_list<value_type>);
_implementation-defined_ xref:#unordered_flat_set_erase_by_position[erase](iterator position);
_implementation-defined_ xref:#unordered_flat_set_erase_by_position[erase](const_iterator position);
_convertible-to-iterator_ xref:#unordered_flat_set_erase_by_position[erase](iterator position);
_convertible-to-iterator_ xref:#unordered_flat_set_erase_by_position[erase](const_iterator position);
size_type xref:#unordered_flat_set_erase_by_key[erase](const key_type& k);
template<class K> size_type xref:#unordered_flat_set_erase_by_key[erase](K&& k);
iterator xref:#unordered_flat_set_erase_range[erase](const_iterator first, const_iterator last);
@ -847,8 +847,8 @@ Notes:;; Can invalidate iterators, pointers and references, but only if the inse
[source,c++,subs=+quotes]
----
_implementation-defined_ erase(iterator position);
_implementation-defined_ erase(const_iterator position);
_convertible-to-iterator_ erase(iterator position);
_convertible-to-iterator_ erase(const_iterator position);
----
Erase the element pointed to by `position`.

8
doc/unordered/unordered_node_map.adoc
View File

@ -155,8 +155,8 @@ namespace boost {
template<class K, class M>
iterator xref:#unordered_node_map_insert_or_assign_with_hint[insert_or_assign](const_iterator hint, K&& k, M&& obj);
_implementation-defined_ xref:#unordered_node_map_erase_by_position[erase](iterator position);
_implementation-defined_ xref:#unordered_node_map_erase_by_position[erase](const_iterator position);
_convertible-to-iterator_ xref:#unordered_node_map_erase_by_position[erase](iterator position);
_convertible-to-iterator_ xref:#unordered_node_map_erase_by_position[erase](const_iterator position);
size_type xref:#unordered_node_map_erase_by_key[erase](const key_type& k);
template<class K> size_type xref:#unordered_node_map_erase_by_key[erase](K&& k);
iterator xref:#unordered_node_map_erase_range[erase](const_iterator first, const_iterator last);
@ -1106,8 +1106,8 @@ The `template<class K, class M>` only participates in overload resolution if `Ha
[source,c++,subs=+quotes]
----
_implementation-defined_ erase(iterator position);
_implementation-defined_ erase(const_iterator position);
_convertible-to-iterator_ erase(iterator position);
_convertible-to-iterator_ erase(const_iterator position);
----
Erase the element pointed to by `position`.

8
doc/unordered/unordered_node_set.adoc
View File

@ -123,8 +123,8 @@ namespace boost {
insert_return_type xref:#unordered_node_set_insert_node[insert](node_type&& nh);
iterator xref:#unordered_node_set_insert_node_with_hint[insert](const_iterator hint, node_type&& nh);
_implementation-defined_ xref:#unordered_node_set_erase_by_position[erase](iterator position);
_implementation-defined_ xref:#unordered_node_set_erase_by_position[erase](const_iterator position);
_convertible-to-iterator_ xref:#unordered_node_set_erase_by_position[erase](iterator position);
_convertible-to-iterator_ xref:#unordered_node_set_erase_by_position[erase](const_iterator position);
size_type xref:#unordered_node_set_erase_by_key[erase](const key_type& k);
template<class K> size_type xref:#unordered_node_set_erase_by_key[erase](K&& k);
iterator xref:#unordered_node_set_erase_range[erase](const_iterator first, const_iterator last);
@ -920,8 +920,8 @@ Notes:;; Behavior is undefined if `nh` is not empty and the allocators of `nh` a
[source,c++,subs=+quotes]
----
_implementation-defined_ erase(iterator position);
_implementation-defined_ erase(const_iterator position);
_convertible-to-iterator_ erase(iterator position);
_convertible-to-iterator_ erase(const_iterator position);
----
Erase the element pointed to by `position`.